KnowledgeBaseRetrievalStartedEvent interface

Package:

@azure/search-documents

Emitted once retrieval preflight validation completes, before any activity begins.

Properties

knowledgeBaseName	The name of the knowledge base being queried.
outputMode	The effective output mode for this retrieval.
reasoningEffort	The effective reasoning effort for this retrieval.
requestId	A service-generated identifier that correlates all events in this retrieval stream.

Property Details

knowledgeBaseName

The name of the knowledge base being queried.

knowledgeBaseName: string

Property Value

string

outputMode

The effective output mode for this retrieval.

outputMode: string

Property Value

string

reasoningEffort

The effective reasoning effort for this retrieval.

reasoningEffort: KnowledgeRetrievalReasoningEffortUnion

Property Value

KnowledgeRetrievalReasoningEffortUnion

requestId

A service-generated identifier that correlates all events in this retrieval stream.

requestId: string

Property Value

string