SearchModelFactory.KnowledgeBaseRetrievalStartedEvent Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Emitted once retrieval preflight validation completes, before any activity begins.
public static Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalStartedEvent KnowledgeBaseRetrievalStartedEvent(string requestId = default, string knowledgeBaseName = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalOutputMode outputMode = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort reasoningEffort = default);static member KnowledgeBaseRetrievalStartedEvent : string * string * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalOutputMode * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeRetrievalReasoningEffort -> Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalStartedEventPublic Shared Function KnowledgeBaseRetrievalStartedEvent (Optional requestId As String = Nothing, Optional knowledgeBaseName As String = Nothing, Optional outputMode As KnowledgeRetrievalOutputMode = Nothing, Optional reasoningEffort As KnowledgeRetrievalReasoningEffort = Nothing) As KnowledgeBaseRetrievalStartedEventParameters
- requestId
- String
A service-generated identifier that correlates all events in this retrieval stream.
- knowledgeBaseName
- String
The name of the knowledge base being queried.
- outputMode
- KnowledgeRetrievalOutputMode
The effective output mode for this retrieval.
- reasoningEffort
- KnowledgeRetrievalReasoningEffort
The effective reasoning effort for this retrieval.
Returns
A new KnowledgeBaseRetrievalStartedEvent instance for mocking.
