BaseKnowledgeSourceParams interface

Package:

@azure/search-documents

Properties

alwaysQuerySource	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
includeReferences	Indicates whether references should be included for data retrieved from this source.
includeReferenceSourceData	Indicates whether references should include the structured data obtained during retrieval in their payload.
kind	Polymorphic discriminator, which specifies the different types this object can be
knowledgeSourceName	The name of the index the params apply to.
rerankerThreshold	The reranker threshold all retrieved documents must meet to be included in the response.

Property Details

alwaysQuerySource

Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.

alwaysQuerySource?: boolean

Property Value

boolean

includeReferences

Indicates whether references should be included for data retrieved from this source.

includeReferences?: boolean

Property Value

boolean

includeReferenceSourceData

Indicates whether references should include the structured data obtained during retrieval in their payload.

includeReferenceSourceData?: boolean

Property Value

boolean

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "azureBlob" | "searchIndex" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint"

Property Value

"azureBlob" | "searchIndex" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint"

knowledgeSourceName

The name of the index the params apply to.

knowledgeSourceName: string

Property Value

string

rerankerThreshold

The reranker threshold all retrieved documents must meet to be included in the response.

rerankerThreshold?: number

Property Value

number