KnowledgeBaseReference Class

Definition

Namespace:
Azure.Search.Documents.KnowledgeBases.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v12.1.0-beta.1
Source:
KnowledgeBaseReference.cs
Source:
KnowledgeBaseReference.cs

Base type for references. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseSearchIndexReference, KnowledgeBaseAzureBlobReference, KnowledgeBaseIndexedSharePointReference, KnowledgeBaseIndexedOneLakeReference, KnowledgeBaseWebReference, KnowledgeBaseRemoteSharePointReference, KnowledgeBaseWorkIQReference, KnowledgeBaseFabricDataAgentReference, KnowledgeBaseFabricOntologyReference, KnowledgeBaseMcpServerReference, KnowledgeBaseFileReference, and KnowledgeBaseIndexedSqlReference.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.KnowledgeBases.Models.UnknownKnowledgeBaseReference))]
public abstract class KnowledgeBaseReference : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.KnowledgeBases.Models.UnknownKnowledgeBaseReference))>]
type KnowledgeBaseReference = class
    interface IJsonModel<KnowledgeBaseReference>
    interface IPersistableModel<KnowledgeBaseReference>
Public MustInherit Class KnowledgeBaseReference
Implements IJsonModel(Of KnowledgeBaseReference), IPersistableModel(Of KnowledgeBaseReference)
Inheritance
Object
KnowledgeBaseReference
Derived
Attributes
PersistableModelProxyAttribute
Implements
IJsonModel<KnowledgeBaseReference> IPersistableModel<KnowledgeBaseReference> IPersistableModel<T>

Properties

Name Description
ActivitySource

The source activity ID for the reference.
Id

The ID of the reference.
RerankerScore

The reranker score for the document reference.
SourceData

The source data for the reference.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<KnowledgeBaseReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KnowledgeBaseReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<KnowledgeBaseReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<KnowledgeBaseReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KnowledgeBaseReference>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to