KnowledgeBaseIndexedSqlActivityRecord interface

Package:

@azure/search-documents

Represents an indexed SQL retrieval activity record.

Extends

BaseKnowledgeBaseActivityRecord

Properties

count	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
imageServing	Statistics about image serving for this retrieval activity
indexedSqlArguments	The indexed SQL arguments for the retrieval activity.
knowledgeSourceName	The knowledge source for the retrieval activity.
queryHintProcessing	Details about the expressions generated from query hints for this activity.
queryTime	The query time for this retrieval activity.
type	The discriminator value.

Inherited Properties

completedAt	The time at which the activity completed.
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.
startedAt	The time at which the activity started.
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

count

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

count?: number

Property Value

number

imageServing

Statistics about image serving for this retrieval activity

imageServing?: ImageServingStatistics

Property Value

ImageServingStatistics

indexedSqlArguments

The indexed SQL arguments for the retrieval activity.

indexedSqlArguments?: KnowledgeBaseIndexedSqlActivityArguments

Property Value

KnowledgeBaseIndexedSqlActivityArguments

knowledgeSourceName

The knowledge source for the retrieval activity.

knowledgeSourceName?: string

Property Value

string

queryHintProcessing

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

queryHintProcessing?: KnowledgeBaseQueryHintProcessing

Property Value

KnowledgeBaseQueryHintProcessing

queryTime

The query time for this retrieval activity.

queryTime?: Date

Property Value

Date

type

The discriminator value.

type: "indexedSql"

Property Value

"indexedSql"

Inherited Property Details

completedAt

The time at which the activity completed.

completedAt?: Date

Property Value

Date

Inherited From KnowledgeBaseActivityRecord.completedAt

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

startedAt

The time at which the activity started.

startedAt?: Date

Property Value

Date

Inherited From KnowledgeBaseActivityRecord.startedAt

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