다음을 통해 공유


KnowledgeAgentRetrievalActivityRecord Class

Definition

Represents a retrieval activity record. Please note KnowledgeAgentRetrievalActivityRecord 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 KnowledgeAgentAzureBlobActivityRecord and KnowledgeAgentSearchIndexActivityRecord.

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

Properties

Count

The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.

ElapsedMs

The elapsed time in milliseconds for the retrieval activity.

(Inherited from KnowledgeAgentActivityRecord)
Id

The ID of the activity record.

(Inherited from KnowledgeAgentActivityRecord)
KnowledgeSourceName

The knowledge source for the retrieval activity.

QueryTime

The query time for this retrieval activity.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<KnowledgeAgentActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from KnowledgeAgentActivityRecord)
IJsonModel<KnowledgeAgentRetrievalActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<KnowledgeAgentRetrievalActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<KnowledgeAgentActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from KnowledgeAgentActivityRecord)
IPersistableModel<KnowledgeAgentRetrievalActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<KnowledgeAgentRetrievalActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<KnowledgeAgentRetrievalActivityRecord>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to