KnowledgeBaseRetrievalStartedEvent Class

Definition

Namespace:

Azure.Search.Documents.KnowledgeBases.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.2

Source:

KnowledgeBaseRetrievalStartedEvent.cs

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

public class KnowledgeBaseRetrievalStartedEvent : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalStartedEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalStartedEvent>

type KnowledgeBaseRetrievalStartedEvent = class
    interface IJsonModel<KnowledgeBaseRetrievalStartedEvent>
    interface IPersistableModel<KnowledgeBaseRetrievalStartedEvent>

Public Class KnowledgeBaseRetrievalStartedEvent
Implements IJsonModel(Of KnowledgeBaseRetrievalStartedEvent), IPersistableModel(Of KnowledgeBaseRetrievalStartedEvent)

Inheritance

Object

KnowledgeBaseRetrievalStartedEvent

Implements

IJsonModel<KnowledgeBaseRetrievalStartedEvent> IPersistableModel<KnowledgeBaseRetrievalStartedEvent> IPersistableModel<T>

Properties

Name	Description
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.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name	Description
Explicit(Response to KnowledgeBaseRetrievalStartedEvent)

Explicit Interface Implementations

Name	Description
IJsonModel<KnowledgeBaseRetrievalStartedEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<KnowledgeBaseRetrievalStartedEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseRetrievalStartedEvent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseRetrievalStartedEvent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseRetrievalStartedEvent>.Write(ModelReaderWriterOptions)