KnowledgeSourceParams Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Base type for knowledge source runtime parameters. Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSourceParams, AzureBlobKnowledgeSourceParams, IndexedSharePointKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, WebKnowledgeSourceParams, RemoteSharePointKnowledgeSourceParams, WorkIQKnowledgeSourceParams, FabricDataAgentKnowledgeSourceParams, FabricOntologyKnowledgeSourceParams, McpServerKnowledgeSourceParams, FileKnowledgeSourceParams, and IndexedSqlKnowledgeSourceParams.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.KnowledgeBases.Models.UnknownKnowledgeSourceParams))]
public abstract class KnowledgeSourceParams : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceParams>[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.KnowledgeBases.Models.UnknownKnowledgeSourceParams))>]
type KnowledgeSourceParams = class
interface IJsonModel<KnowledgeSourceParams>
interface IPersistableModel<KnowledgeSourceParams>Public MustInherit Class KnowledgeSourceParams
Implements IJsonModel(Of KnowledgeSourceParams), IPersistableModel(Of KnowledgeSourceParams)- Inheritance
-
KnowledgeSourceParams
- Derived
- Attributes
- Implements
Properties
| Name | Description |
|---|---|
| AlwaysQuerySource |
Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. |
| 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. |
| FailOnError |
Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false. |
| 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. |
| KnowledgeSourceName |
The name of the index the params apply to. |
| MaxOutputDocuments |
Limits the maximum number of documents returned from this knowledge source. |
| RerankerThreshold |
The reranker threshold all retrieved documents must meet to be included in the response. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<KnowledgeSourceParams>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<KnowledgeSourceParams>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<KnowledgeSourceParams>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<KnowledgeSourceParams>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<KnowledgeSourceParams>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
