ItemFieldWebSearchToolCall Class

Definition

Web search tool call.

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

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" }.

Id

The unique ID of the web search tool call.

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<ItemField>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ItemField)
IJsonModel<ItemField>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ItemField)
IJsonModel<ItemFieldWebSearchToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ItemFieldWebSearchToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ItemField>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ItemField)
IPersistableModel<ItemField>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ItemField)
IPersistableModel<ItemField>.Write(ModelReaderWriterOptions) (Inherited from ItemField)
IPersistableModel<ItemFieldWebSearchToolCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ItemFieldWebSearchToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ItemFieldWebSearchToolCall>.Write(ModelReaderWriterOptions)

Applies to