Lingua

SearchModelFactory.KnowledgeBaseSearchIndexActivityRecord Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.1.0-beta.2
Source:
SearchModelFactory.cs

Represents a search index retrieval activity record.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseSearchIndexActivityRecord KnowledgeBaseSearchIndexActivityRecord(int id = 0, DateTimeOffset? startedOn = default, DateTimeOffset? completedOn = default, int? elapsedMs = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail error = default, string warning = default, string knowledgeSourceName = default, DateTimeOffset? queryOn = default, int? count = default, Azure.Search.Documents.KnowledgeBases.Models.ImageServingStatistics imageServing = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseSearchIndexActivityArguments searchIndexArguments = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseQueryHintProcessing queryHintProcessing = default);
static member KnowledgeBaseSearchIndexActivityRecord : int * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail * string * string * Nullable<DateTimeOffset> * Nullable<int> * Azure.Search.Documents.KnowledgeBases.Models.ImageServingStatistics * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseSearchIndexActivityArguments * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseQueryHintProcessing -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseSearchIndexActivityRecord
Public Shared Function KnowledgeBaseSearchIndexActivityRecord (Optional id As Integer = 0, Optional startedOn As Nullable(Of DateTimeOffset) = Nothing, Optional completedOn As Nullable(Of DateTimeOffset) = Nothing, Optional elapsedMs As Nullable(Of Integer) = Nothing, Optional error As KnowledgeBaseErrorDetail = Nothing, Optional warning As String = Nothing, Optional knowledgeSourceName As String = Nothing, Optional queryOn As Nullable(Of DateTimeOffset) = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional imageServing As ImageServingStatistics = Nothing, Optional searchIndexArguments As KnowledgeBaseSearchIndexActivityArguments = Nothing, Optional queryHintProcessing As KnowledgeBaseQueryHintProcessing = Nothing) As KnowledgeBaseSearchIndexActivityRecord

Parameters

id
Int32

The ID of the activity record.

startedOn
Nullable<DateTimeOffset>

The time at which the activity started.

completedOn
Nullable<DateTimeOffset>

The time at which the activity completed.

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.

knowledgeSourceName
String

The knowledge source for the retrieval activity.

queryOn
Nullable<DateTimeOffset>

The query time for this retrieval activity.

count
Nullable<Int32>

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

imageServing
ImageServingStatistics

Statistics about image serving for this retrieval activity.

searchIndexArguments
KnowledgeBaseSearchIndexActivityArguments

The search index arguments for the retrieval activity.

queryHintProcessing
KnowledgeBaseQueryHintProcessing

Details about the expressions generated from query hints for this activity.

Returns

KnowledgeBaseSearchIndexActivityRecord

A new KnowledgeBaseSearchIndexActivityRecord instance for mocking.

Applies to