SearchModelFactory.KnowledgeBaseActivityRecord Method

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

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

Source:

SearchModelFactory.cs

Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseSearchIndexActivityRecord, KnowledgeBaseAzureBlobActivityRecord, KnowledgeBaseIndexedSharePointActivityRecord, KnowledgeBaseIndexedOneLakeActivityRecord, KnowledgeBaseWebActivityRecord, KnowledgeBaseRemoteSharePointActivityRecord, KnowledgeBaseWorkIQActivityRecord, KnowledgeBaseFabricDataAgentActivityRecord, KnowledgeBaseFabricOntologyActivityRecord, KnowledgeBaseMcpServerActivityRecord, KnowledgeBaseFileActivityRecord, KnowledgeBaseIndexedSqlActivityRecord, KnowledgeBaseModelQueryPlanningActivityRecord, KnowledgeBaseModelAnswerSynthesisActivityRecord, KnowledgeBaseModelWebSummarizationActivityRecord, and KnowledgeBaseAgenticReasoningActivityRecord.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord KnowledgeBaseActivityRecord(int id = 0, string type = default, int? elapsedMs = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail error = default, string warning = default);

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

Public Shared Function KnowledgeBaseActivityRecord (Optional id As Integer = 0, Optional type As String = Nothing, Optional elapsedMs As Nullable(Of Integer) = Nothing, Optional error As KnowledgeBaseErrorDetail = Nothing, Optional warning As String = Nothing) As KnowledgeBaseActivityRecord

Parameters

id

Int32

The ID of the activity record.

type

String

The type 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.

Returns

KnowledgeBaseActivityRecord

A new KnowledgeBaseActivityRecord instance for mocking.