BaseKnowledgeSourceParams interface
Base type for knowledge source runtime parameters.
Properties
| always |
Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. |
| enable |
Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models. |
| fail |
Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false. |
| include |
Indicates whether references should be included for data retrieved from this source. |
| include |
Indicates whether references should include the structured data obtained during retrieval in their payload. |
| kind | The discriminator possible values: searchIndex, azureBlob, indexedSharePoint, indexedOneLake, web, remoteSharePoint, workIQ, fabricDataAgent, fabricOntology, mcpServer, file, indexedSql |
| knowledge |
The name of the index the params apply to. |
| max |
Limits the maximum number of documents returned from this knowledge source. |
| reranker |
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?: booleanProperty Value
boolean
enableImageServing
Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
enableImageServing?: booleanProperty Value
boolean
failOnError
Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
failOnError?: booleanProperty Value
boolean
includeReferences
Indicates whether references should be included for data retrieved from this source.
includeReferences?: booleanProperty Value
boolean
includeReferenceSourceData
Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferenceSourceData?: booleanProperty Value
boolean
kind
The discriminator possible values: searchIndex, azureBlob, indexedSharePoint, indexedOneLake, web, remoteSharePoint, workIQ, fabricDataAgent, fabricOntology, mcpServer, file, indexedSql
kind: stringProperty Value
string
knowledgeSourceName
The name of the index the params apply to.
knowledgeSourceName: stringProperty Value
string
maxOutputDocuments
Limits the maximum number of documents returned from this knowledge source.
maxOutputDocuments?: numberProperty Value
number
rerankerThreshold
The reranker threshold all retrieved documents must meet to be included in the response.
rerankerThreshold?: numberProperty Value
number
