KnowledgeBaseRetrievalResponse Class

Definition

Namespace:
Azure.Search.Documents.KnowledgeBases.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v11.8.0-beta.1
Source:
KnowledgeBaseRetrievalResponse.cs
Source:
KnowledgeBaseRetrievalResponse.cs

The output contract for the retrieval response.

public class KnowledgeBaseRetrievalResponse : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalResponse>
type KnowledgeBaseRetrievalResponse = class
    interface IJsonModel<KnowledgeBaseRetrievalResponse>
    interface IPersistableModel<KnowledgeBaseRetrievalResponse>
Public Class KnowledgeBaseRetrievalResponse
Implements IJsonModel(Of KnowledgeBaseRetrievalResponse), IPersistableModel(Of KnowledgeBaseRetrievalResponse)
Inheritance
Object
KnowledgeBaseRetrievalResponse
Implements
IJsonModel<KnowledgeBaseRetrievalResponse> IPersistableModel<KnowledgeBaseRetrievalResponse> IPersistableModel<T>

Properties

Name Description
Activity

The activity records for tracking progress and billing implications.
References

The references for the retrieval data used in the response.
Response

The response messages.

Methods

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

Operators

Name Description
Explicit(Response to KnowledgeBaseRetrievalResponse)

Explicit Interface Implementations

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

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

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

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

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

Writes the model into a BinaryData.

Applies to