KnowledgeBaseModelQueryPlanningActivityRecord interface

Package:
@azure/search-documents

Represents an LLM query planning activity record.

Extends
BaseKnowledgeBaseActivityRecord

Properties

inputTokens

The number of input tokens for the LLM query planning activity.
modelName

The name of the model used for the LLM query planning activity.
outputTokens

The number of output tokens for the LLM query planning activity.
type

The discriminator value.

Inherited Properties

elapsedInMs

The elapsed time in milliseconds for the retrieval activity.
error

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

The ID of the activity record.
warning

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.

Property Details

inputTokens

The number of input tokens for the LLM query planning activity.

inputTokens?: number

Property Value

number

modelName

The name of the model used for the LLM query planning activity.

modelName?: string

Property Value

string

outputTokens

The number of output tokens for the LLM query planning activity.

outputTokens?: number

Property Value

number

type

The discriminator value.

type: "modelQueryPlanning"

Property Value

"modelQueryPlanning"

Inherited Property Details

elapsedInMs

The elapsed time in milliseconds for the retrieval activity.

elapsedInMs?: number

Property Value

number

Inherited From KnowledgeBaseActivityRecord.elapsedInMs

error

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

error?: KnowledgeBaseErrorDetail

Property Value

KnowledgeBaseErrorDetail

Inherited From KnowledgeBaseActivityRecord.error

id

The ID of the activity record.

id: number

Property Value

number

Inherited From KnowledgeBaseActivityRecord.id

warning

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.

warning?: string

Property Value

string

Inherited From KnowledgeBaseActivityRecord.warning