KnowledgeAgentReference Class

Definition

Namespace:: Azure.Search.Documents.Agents.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.7.0-beta.7

Source:: KnowledgeAgentReference.cs

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 references. Please note KnowledgeAgentReference is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeAgentAzureBlobReference and KnowledgeAgentSearchIndexReference.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeAgentReference))]
public abstract class KnowledgeAgentReference : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Agents.Models.KnowledgeAgentReference>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Agents.Models.KnowledgeAgentReference>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeAgentReference))>]
type KnowledgeAgentReference = class
    interface IJsonModel<KnowledgeAgentReference>
    interface IPersistableModel<KnowledgeAgentReference>

Public MustInherit Class KnowledgeAgentReference
Implements IJsonModel(Of KnowledgeAgentReference), IPersistableModel(Of KnowledgeAgentReference)

Inheritance: Object
KnowledgeAgentReference

Derived: Azure.Search.Documents.Agents.Models.KnowledgeAgentAzureBlobReference

Azure.Search.Documents.Agents.Models.KnowledgeAgentSearchIndexReference

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<KnowledgeAgentReference> IPersistableModel<KnowledgeAgentReference> IPersistableModel<T>

Constructors

KnowledgeAgentReference(String, Int32)

Initializes a new instance of KnowledgeAgentReference.

Properties

ActivitySource	The source activity ID for the reference.
Id	The ID of the reference.
RerankerScore	The reranker score for the document reference.
SourceData	Dictionary of <any>.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<KnowledgeAgentReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KnowledgeAgentReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<KnowledgeAgentReference>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<KnowledgeAgentReference>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KnowledgeAgentReference>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to