WebSearchTool Class

Definition

Web search.

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

Constructors

Name Description
WebSearchTool()

Initializes a new instance of WebSearchTool.

Properties

Name Description
CustomSearchConfiguration

The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.

Description

Optional user-defined description for this tool or configuration.

Filters

Gets or sets the Filters.

Name

Optional user-defined name for this tool or configuration.

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.

UserLocation

Gets or sets the UserLocation.

Methods

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

Explicit Interface Implementations

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

Applies to