KnowledgeBaseSearchIndexActivityArguments interface

Package:

@azure/search-documents

Represents the arguments the search index retrieval activity was run with.

Properties

filter	The filter string.
queryType	The query syntax used to execute the search. Query hints can cause semantic queries to use full query syntax.
search	The search string used to query the search index.
searchFields	What fields were searched against.
semanticConfigurationName	What semantic configuration was used from the search index.
sourceDataFields	What fields were selected for search.

Property Details

filter

The filter string.

filter?: string

Property Value

string

queryType

The query syntax used to execute the search. Query hints can cause semantic queries to use full query syntax.

queryType?: string

Property Value

string

search

The search string used to query the search index.

search?: string

Property Value

string

searchFields

What fields were searched against.

searchFields?: SearchIndexFieldReference[]

Property Value

SearchIndexFieldReference[]

semanticConfigurationName

What semantic configuration was used from the search index.

semanticConfigurationName?: string

Property Value

string

sourceDataFields

What fields were selected for search.

sourceDataFields?: SearchIndexFieldReference[]

Property Value

SearchIndexFieldReference[]