KnowledgeBaseMcpServerReference Class

Definition

Namespace:

Azure.Search.Documents.KnowledgeBases.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.1

Source:

KnowledgeBaseMcpServerReference.cs

Represents an MCP server document reference.

public class KnowledgeBaseMcpServerReference : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseReference, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMcpServerReference>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseMcpServerReference>

type KnowledgeBaseMcpServerReference = class
    inherit KnowledgeBaseReference
    interface IJsonModel<KnowledgeBaseMcpServerReference>
    interface IPersistableModel<KnowledgeBaseMcpServerReference>

Public Class KnowledgeBaseMcpServerReference
Inherits KnowledgeBaseReference
Implements IJsonModel(Of KnowledgeBaseMcpServerReference), IPersistableModel(Of KnowledgeBaseMcpServerReference)

Inheritance

Object

KnowledgeBaseReference

KnowledgeBaseMcpServerReference

Implements

IJsonModel<KnowledgeBaseMcpServerReference> IPersistableModel<KnowledgeBaseMcpServerReference> IPersistableModel<T>

Properties

Name	Description
ActivitySource	The source activity ID for the reference. (Inherited from KnowledgeBaseReference)
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)
Title	The title of the MCP server tool result.
ToolName	The name of the MCP server tool that produced the reference.

Methods

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

Explicit Interface Implementations

Name	Description
IJsonModel<KnowledgeBaseMcpServerReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<KnowledgeBaseMcpServerReference>.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<KnowledgeBaseMcpServerReference>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseMcpServerReference>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseMcpServerReference>.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)