Share via

WebSearchPreviewTool Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
WebSearchPreviewTool.cs

Note: web_search is not yet available via Azure OpenAI.

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

Constructors

Name Description
WebSearchPreviewTool()

Initializes a new instance of WebSearchPreviewTool.
WebSearchPreviewTool(ToolType, IDictionary<String,BinaryData>, Location, Nullable<WebSearchPreviewToolSearchContextSize>)

Initializes a new instance of WebSearchPreviewTool.

Properties

Name Description
SearchContextSize

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
Type

Gets or sets the type.

(Inherited from Tool)
UserLocation

The user's location. Please note Location 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 ApproximateLocation.

Methods

Name Description
DeserializeWebSearchPreviewTool(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<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from Tool)
IJsonModel<WebSearchPreviewTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<WebSearchPreviewTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from Tool)
IPersistableModel<WebSearchPreviewTool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<WebSearchPreviewTool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<WebSearchPreviewTool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to