ResponsesWebSearchTool Class

Definition

Web search.

public class ResponsesWebSearchTool : Azure.AI.Extensions.OpenAI.ResponsesTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.ResponsesWebSearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.ResponsesWebSearchTool>
type ResponsesWebSearchTool = class
    inherit ResponsesTool
    interface IJsonModel<ResponsesWebSearchTool>
    interface IPersistableModel<ResponsesWebSearchTool>
Public Class ResponsesWebSearchTool
Inherits ResponsesTool
Implements IJsonModel(Of ResponsesWebSearchTool), IPersistableModel(Of ResponsesWebSearchTool)
Inheritance
ResponsesWebSearchTool
Implements

Constructors

Name Description
ResponsesWebSearchTool()

Initializes a new instance of ResponsesWebSearchTool.

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.

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.

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

Applies to