WebSearchToolboxTool Class

Definition

A web search tool stored in a toolbox.

public class WebSearchToolboxTool : Azure.AI.Projects.Agents.ToolboxTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.WebSearchToolboxTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.WebSearchToolboxTool>
type WebSearchToolboxTool = class
    inherit ToolboxTool
    interface IJsonModel<WebSearchToolboxTool>
    interface IPersistableModel<WebSearchToolboxTool>
Public Class WebSearchToolboxTool
Inherits ToolboxTool
Implements IJsonModel(Of WebSearchToolboxTool), IPersistableModel(Of WebSearchToolboxTool)
Inheritance
WebSearchToolboxTool
Implements

Constructors

Name Description
WebSearchToolboxTool()

Initializes a new instance of WebSearchToolboxTool.

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.

(Inherited from ToolboxTool)
Filters

Gets or sets the Filters.

Name

Optional user-defined name for this tool or configuration.

(Inherited from ToolboxTool)
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.

ToolConfigs

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

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

Applies to