SearchModelFactory.KnowledgeBaseModelWebSummarizationActivityRecord 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 LLM web summarization activity record.

public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseModelWebSummarizationActivityRecord KnowledgeBaseModelWebSummarizationActivityRecord(int id = 0, int? elapsedMs = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseErrorDetail error = default, string warning = default, int? inputTokensCount = default, int? outputTokensCount = default, string modelName = default);

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

Public Shared Function KnowledgeBaseModelWebSummarizationActivityRecord (Optional id As Integer = 0, Optional elapsedMs As Nullable(Of Integer) = Nothing, Optional error As KnowledgeBaseErrorDetail = Nothing, Optional warning As String = Nothing, Optional inputTokensCount As Nullable(Of Integer) = Nothing, Optional outputTokensCount As Nullable(Of Integer) = Nothing, Optional modelName As String = Nothing) As KnowledgeBaseModelWebSummarizationActivityRecord

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.

inputTokensCount

Nullable<Int32>

The number of input tokens for the LLM web summarization activity.

outputTokensCount

Nullable<Int32>

The number of output tokens for the LLM web summarization activity.

modelName

String

The name of the model used for the LLM web summarization activity.

Returns

KnowledgeBaseModelWebSummarizationActivityRecord

A new KnowledgeBaseModelWebSummarizationActivityRecord instance for mocking.