BaseKnowledgeBaseActivityRecord interface

Package:

@azure/search-documents

Base type for activity records.

Properties

elapsedMs	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.
type	Polymorphic discriminator, which specifies the different types this object can be

Property Details

elapsedMs

The elapsed time in milliseconds for the retrieval activity.

elapsedMs?: number

Property Value

number

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

id

The ID of the activity record.

id: number

Property Value

number

type

Polymorphic discriminator, which specifies the different types this object can be

type: "azureBlob" | "KnowledgeBaseRetrievalActivityRecord" | "searchIndex" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint" | "modelQueryPlanning" | "modelAnswerSynthesis" | "agenticReasoning"

Property Value

"azureBlob" | "KnowledgeBaseRetrievalActivityRecord" | "searchIndex" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint" | "modelQueryPlanning" | "modelAnswerSynthesis" | "agenticReasoning"