BaseKnowledgeSourceParams interface

Package:

@azure/search-documents

Base type for knowledge source runtime parameters.

Properties

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	The discriminator possible values: searchIndex, azureBlob, indexedOneLake, web
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

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

The discriminator possible values: searchIndex, azureBlob, indexedOneLake, web

kind: string

Property Value

string

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