ResponseWebSearchCallCompletedEvent Class
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.
Note: web_search is not yet available via Azure OpenAI.
public class ResponseWebSearchCallCompletedEvent : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseWebSearchCallCompletedEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseWebSearchCallCompletedEvent>
type ResponseWebSearchCallCompletedEvent = class
inherit ResponseStreamEvent
interface IUtf8JsonSerializable
interface IJsonModel<ResponseWebSearchCallCompletedEvent>
interface IPersistableModel<ResponseWebSearchCallCompletedEvent>
Public Class ResponseWebSearchCallCompletedEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseWebSearchCallCompletedEvent), IPersistableModel(Of ResponseWebSearchCallCompletedEvent)
- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ResponseWebSearchCallCompletedEvent() |
Initializes a new instance of ResponseWebSearchCallCompletedEvent for deserialization. |
| ResponseWebSearchCallCompletedEvent(Int32, Int32, String) |
Initializes a new instance of ResponseWebSearchCallCompletedEvent. |
| ResponseWebSearchCallCompletedEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, Int32, String) |
Initializes a new instance of ResponseWebSearchCallCompletedEvent. |
Properties
| Name | Description |
|---|---|
| ItemId |
Unique ID for the output item associated with the web search call. |
| OutputIndex |
The index of the output item that the web search call is associated with. |
| SequenceNumber |
The sequence number for this event. (Inherited from ResponseStreamEvent) |
| Type |
Gets or sets the type. (Inherited from ResponseStreamEvent) |
Methods
| Name | Description |
|---|---|
| DeserializeResponseWebSearchCallCompletedEvent(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |