Share via


KnowledgeBaseAgenticReasoningActivityRecord Class

Definition

Represents an agentic reasoning activity record.

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

Properties

Name Description
ElapsedMs

The elapsed time in milliseconds for the retrieval activity.

(Inherited from KnowledgeBaseActivityRecord)
Error

The error detail explaining why the operation failed. This property is only included when the activity does not succeed.

(Inherited from KnowledgeBaseActivityRecord)
Id

The ID of the activity record.

(Inherited from KnowledgeBaseActivityRecord)
ReasoningTokens

The number of input tokens for agentic reasoning.

RetrievalReasoningEffort

Gets the retrieval reasoning effort Please note KnowledgeRetrievalReasoningEffort 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 KnowledgeRetrievalLowReasoningEffort, KnowledgeRetrievalMediumReasoningEffort and KnowledgeRetrievalMinimalReasoningEffort.

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from KnowledgeBaseActivityRecord)
IJsonModel<KnowledgeBaseAgenticReasoningActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<KnowledgeBaseAgenticReasoningActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<KnowledgeBaseActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from KnowledgeBaseActivityRecord)
IPersistableModel<KnowledgeBaseAgenticReasoningActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<KnowledgeBaseAgenticReasoningActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<KnowledgeBaseAgenticReasoningActivityRecord>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to