Share via


ResponseFileSearchCallCompletedEvent Class

Definition

Emitted when a file search call is completed (results found).

public class ResponseFileSearchCallCompletedEvent : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseFileSearchCallCompletedEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseFileSearchCallCompletedEvent>
type ResponseFileSearchCallCompletedEvent = class
    inherit ResponseStreamEvent
    interface IUtf8JsonSerializable
    interface IJsonModel<ResponseFileSearchCallCompletedEvent>
    interface IPersistableModel<ResponseFileSearchCallCompletedEvent>
Public Class ResponseFileSearchCallCompletedEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseFileSearchCallCompletedEvent), IPersistableModel(Of ResponseFileSearchCallCompletedEvent)
Inheritance
ResponseFileSearchCallCompletedEvent
Implements

Constructors

Name Description
ResponseFileSearchCallCompletedEvent()

Initializes a new instance of ResponseFileSearchCallCompletedEvent for deserialization.

ResponseFileSearchCallCompletedEvent(Int32, Int32, String)

Initializes a new instance of ResponseFileSearchCallCompletedEvent.

ResponseFileSearchCallCompletedEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, Int32, String)

Initializes a new instance of ResponseFileSearchCallCompletedEvent.

Properties

Name Description
ItemId

The ID of the output item that the file search call is initiated.

OutputIndex

The index of the output item that the file search call is initiated.

SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

Name Description
DeserializeResponseFileSearchCallCompletedEvent(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ResponseFileSearchCallCompletedEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ResponseFileSearchCallCompletedEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseFileSearchCallCompletedEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponseFileSearchCallCompletedEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ResponseFileSearchCallCompletedEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ResponseStreamEvent)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to