KnowledgeAgentRetrievalResponse Class

Definition

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

Assembly:: Azure.Search.Documents.dll

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

Source:: KnowledgeAgentRetrievalResponse.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.

The output contract for the retrieval response.

public class KnowledgeAgentRetrievalResponse : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Agents.Models.KnowledgeAgentRetrievalResponse>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Agents.Models.KnowledgeAgentRetrievalResponse>

type KnowledgeAgentRetrievalResponse = class
    interface IJsonModel<KnowledgeAgentRetrievalResponse>
    interface IPersistableModel<KnowledgeAgentRetrievalResponse>

Public Class KnowledgeAgentRetrievalResponse
Implements IJsonModel(Of KnowledgeAgentRetrievalResponse), IPersistableModel(Of KnowledgeAgentRetrievalResponse)

Inheritance: Object
KnowledgeAgentRetrievalResponse

Implements: IJsonModel<KnowledgeAgentRetrievalResponse> IPersistableModel<KnowledgeAgentRetrievalResponse> IPersistableModel<T>

Properties

Activity	The activity records for tracking progress and billing implications. Please note KnowledgeAgentActivityRecord 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 KnowledgeAgentSearchActivityRecord, KnowledgeAgentSemanticRankerActivityRecord and KnowledgeAgentModelQueryPlanningActivityRecord.
References	The references for the retrieval data used in the response. 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 KnowledgeAgentAzureSearchDocReference.
Response	Gets the response.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to