SearchModelFactory.KnowledgeBaseIndexedSqlActivityRecord 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 indexed SQL retrieval activity record.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseIndexedSqlActivityRecord KnowledgeBaseIndexedSqlActivityRecord(int id = 0, int? elapsedMs = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail error = default, string warning = default, string knowledgeSourceName = default, DateTimeOffset? queryTime = default, int? count = default, Azure.Search.Documents.KnowledgeBases.Models.ImageServingStatistics imageServing = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseIndexedSqlActivityArguments indexedSqlArguments = default);

static member KnowledgeBaseIndexedSqlActivityRecord : int * 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.KnowledgeBaseIndexedSqlActivityArguments -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseIndexedSqlActivityRecord

Public Shared Function KnowledgeBaseIndexedSqlActivityRecord (Optional id As Integer = 0, Optional elapsedMs As Nullable(Of Integer) = Nothing, Optional error As KnowledgeBaseErrorDetail = Nothing, Optional warning As String = Nothing, Optional knowledgeSourceName As String = Nothing, Optional queryTime As Nullable(Of DateTimeOffset) = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional imageServing As ImageServingStatistics = Nothing, Optional indexedSqlArguments As KnowledgeBaseIndexedSqlActivityArguments = Nothing) As KnowledgeBaseIndexedSqlActivityRecord

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.

knowledgeSourceName

String

The knowledge source for the retrieval activity.

queryTime

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.

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

The indexed SQL arguments for the retrieval activity.

Returns

KnowledgeBaseIndexedSqlActivityRecord

A new KnowledgeBaseIndexedSqlActivityRecord instance for mocking.