WebSearchToolCallItemParam 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.
The results of a web search tool call. See the web search guide for more information.
public class WebSearchToolCallItemParam : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemParam, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.WebSearchToolCallItemParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.WebSearchToolCallItemParam>type WebSearchToolCallItemParam = class
inherit ItemParam
interface IUtf8JsonSerializable
interface IJsonModel<WebSearchToolCallItemParam>
interface IPersistableModel<WebSearchToolCallItemParam>Public Class WebSearchToolCallItemParam
Inherits ItemParam
Implements IJsonModel(Of WebSearchToolCallItemParam), IPersistableModel(Of WebSearchToolCallItemParam)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| WebSearchToolCallItemParam() |
Initializes a new instance of WebSearchToolCallItemParam for deserialization. |
| WebSearchToolCallItemParam(ItemType, IDictionary<String,BinaryData>, WebSearchAction) |
Initializes a new instance of WebSearchToolCallItemParam. |
| WebSearchToolCallItemParam(WebSearchAction) |
Initializes a new instance of WebSearchToolCallItemParam. |
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). Please note WebSearchAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include WebSearchActionFind, WebSearchActionOpenPage and WebSearchActionSearch. |
| SerializedAdditionalRawData | (Inherited from ItemParam) |
| Type |
Gets or sets the type. (Inherited from ItemParam) |
Methods
| Name | Description |
|---|---|
| DeserializeWebSearchToolCallItemParam(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |
