KnowledgeBaseRetrievalStreamEvent type

Package:

@azure/search-documents

The set of server-sent events emitted while streaming a knowledge base retrieval.

The stream ends after the terminal response.completed event, or after an error event if the retrieval fails before completing. Narrow on the event property to access the typed payload.

type KnowledgeBaseRetrievalStreamEvent =
  | { data: KnowledgeBaseRetrievalStartedEvent; event: "retrieval.started" }
  | { data: KnowledgeBaseActivityStartedEvent; event: "activity.started" }
  | { data: KnowledgeBaseActivityRecordUnion; event: "activity.completed" }
  | { data: KnowledgeBaseAnswerCompletedEvent; event: "answer.completed" }
  | { data: KnowledgeBaseReferenceUnion[]; event: "references.completed" }
  | { data: KnowledgeBaseStreamErrorEvent; event: "error" }
  | { data: KnowledgeBaseResponseCompletedEvent; event: "response.completed" }