你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

KnowledgeSourceParams Class

Definition

Namespace:
Azure.Search.Documents.KnowledgeBases.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
KnowledgeSourceParams.cs
Source:
KnowledgeSourceParams.cs

Base type for knowledge source runtime parameters. Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSourceParams, AzureBlobKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, and WebKnowledgeSourceParams.

[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.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>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeSourceParams))>]
type KnowledgeSourceParams = class
    interface IJsonModel<KnowledgeSourceParams>
    interface IPersistableModel<KnowledgeSourceParams>
Public MustInherit Class KnowledgeSourceParams
Implements IJsonModel(Of KnowledgeSourceParams), IPersistableModel(Of KnowledgeSourceParams)
Inheritance
Object
KnowledgeSourceParams
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<KnowledgeSourceParams> IPersistableModel<KnowledgeSourceParams> IPersistableModel<T>

Constructors

Name Description
KnowledgeSourceParams(String)

Initializes a new instance of KnowledgeSourceParams.

Properties

Name Description
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.
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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

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.

Applies to