KnowledgeBaseActivityStartedEvent interface

Package:

@azure/search-documents

Emitted immediately before an individual retrieval activity begins executing.

Properties

id	The ID of the activity record, matching the id on the corresponding activity.completed event.
knowledgeSourceName	The knowledge source used by the activity, when the activity targets a knowledge source.
startedAt	The time at which the activity started.
type	The type of the activity that has started.

Property Details

id

The ID of the activity record, matching the id on the corresponding activity.completed event.

id: number

Property Value

number

knowledgeSourceName

The knowledge source used by the activity, when the activity targets a knowledge source.

knowledgeSourceName?: string

Property Value

string

startedAt

The time at which the activity started.

startedAt: Date

Property Value

Date

type

The type of the activity that has started.

type: string

Property Value

string