OutputItemWebSearchToolCall Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
OutputItemWebSearchToolCall.cs

Web search tool call.

public class OutputItemWebSearchToolCall : Azure.AI.AgentServer.Responses.Models.OutputItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.OutputItemWebSearchToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.OutputItemWebSearchToolCall>
type OutputItemWebSearchToolCall = class
    inherit OutputItem
    interface IJsonModel<OutputItemWebSearchToolCall>
    interface IPersistableModel<OutputItemWebSearchToolCall>
Public Class OutputItemWebSearchToolCall
Inherits OutputItem
Implements IJsonModel(Of OutputItemWebSearchToolCall), IPersistableModel(Of OutputItemWebSearchToolCall)
Inheritance
Object
OutputItem
OutputItemWebSearchToolCall
Implements
IJsonModel<OutputItemWebSearchToolCall> IPersistableModel<OutputItemWebSearchToolCall> IPersistableModel<T>

Constructors

Name Description
OutputItemWebSearchToolCall(String, ItemWebSearchToolCallStatus, BinaryData)

Initializes a new instance of OutputItemWebSearchToolCall.

Properties

Name Description
Action

An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

AgentReference

The agent that created the item.

(Inherited from OutputItem)
CreatedBy

The information about the creator of the item

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

(Inherited from OutputItem)
Id

The unique ID of the web search tool call.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Status

The status of the web search tool call.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<OutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItemWebSearchToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemWebSearchToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OutputItem>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.Write(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItemWebSearchToolCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemWebSearchToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemWebSearchToolCall>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
GetId(OutputItem)

Gets the Id property from an OutputItem. Uses direct type checks for known subclasses; falls back to JSON serialization for unrecognized types.

Applies to