KnowledgeBaseFabricDataAgentReference Class

Definition

Represents a Fabric Data Agent document reference.

public class KnowledgeBaseFabricDataAgentReference : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseFabricDataAgentReference>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseFabricDataAgentReference>
type KnowledgeBaseFabricDataAgentReference = class
    inherit KnowledgeBaseReference
    interface IJsonModel<KnowledgeBaseFabricDataAgentReference>
    interface IPersistableModel<KnowledgeBaseFabricDataAgentReference>
Public Class KnowledgeBaseFabricDataAgentReference
Inherits KnowledgeBaseReference
Implements IJsonModel(Of KnowledgeBaseFabricDataAgentReference), IPersistableModel(Of KnowledgeBaseFabricDataAgentReference)
Inheritance
KnowledgeBaseFabricDataAgentReference
Implements

Properties

Name Description
ActivitySource

The source activity ID for the reference.

(Inherited from KnowledgeBaseReference)
DataAgentId

The Fabric Data Agent ID.

Id

The ID of the reference.

(Inherited from KnowledgeBaseReference)
RerankerScore

The reranker score for the document reference.

(Inherited from KnowledgeBaseReference)
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" }.

(Inherited from KnowledgeBaseReference)
WorkspaceId

The Fabric workspace ID.

Methods

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

Explicit Interface Implementations

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

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from KnowledgeBaseReference)
IJsonModel<KnowledgeBaseReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from KnowledgeBaseReference)
IPersistableModel<KnowledgeBaseFabricDataAgentReference>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseFabricDataAgentReference>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseFabricDataAgentReference>.Write(ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseReference>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from KnowledgeBaseReference)
IPersistableModel<KnowledgeBaseReference>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from KnowledgeBaseReference)
IPersistableModel<KnowledgeBaseReference>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from KnowledgeBaseReference)

Applies to