SearchModelFactory.KnowledgeBaseAgenticReasoningActivityRecord Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

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

Source:

SearchModelFactory.cs

Represents an agentic reasoning activity record.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseAgenticReasoningActivityRecord KnowledgeBaseAgenticReasoningActivityRecord(int id = 0, int? elapsedMs = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail error = default, string warning = default, int? reasoningTokens = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort retrievalReasoningEffort = default);

static member KnowledgeBaseAgenticReasoningActivityRecord : int * Nullable<int> * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail * string * Nullable<int> * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseAgenticReasoningActivityRecord

Public Shared Function KnowledgeBaseAgenticReasoningActivityRecord (Optional id As Integer = 0, Optional elapsedMs As Nullable(Of Integer) = Nothing, Optional error As KnowledgeBaseErrorDetail = Nothing, Optional warning As String = Nothing, Optional reasoningTokens As Nullable(Of Integer) = Nothing, Optional retrievalReasoningEffort As KnowledgeRetrievalReasoningEffort = Nothing) As KnowledgeBaseAgenticReasoningActivityRecord

Parameters

id

Int32

The ID of the activity record.

elapsedMs

Nullable<Int32>

The elapsed time in milliseconds for the retrieval activity.

error

KnowledgeBaseErrorDetail

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

warning

String

A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

reasoningTokens

Nullable<Int32>

The number of input tokens for agentic reasoning.

retrievalReasoningEffort

KnowledgeRetrievalReasoningEffort

The retrieval reasoning effort configuration.

Returns

KnowledgeBaseAgenticReasoningActivityRecord

A new KnowledgeBaseAgenticReasoningActivityRecord instance for mocking.