ProjectsAgentsModelFactory.WebSearchToolboxTool Method
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.
A web search tool stored in a toolbox.
public static Azure.AI.Projects.Agents.WebSearchToolboxTool WebSearchToolboxTool(string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Extensions.OpenAI.ToolConfig> toolConfigs = default, OpenAI.Responses.WebSearchToolFilters filters = default, OpenAI.Responses.WebSearchToolApproximateLocation userLocation = default, OpenAI.WebSearchToolSearchContextSize? searchContextSize = default, Azure.AI.Extensions.OpenAI.WebSearchConfiguration customSearchConfiguration = default);static member WebSearchToolboxTool : string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Extensions.OpenAI.ToolConfig> * OpenAI.Responses.WebSearchToolFilters * OpenAI.Responses.WebSearchToolApproximateLocation * Nullable<OpenAI.WebSearchToolSearchContextSize> * Azure.AI.Extensions.OpenAI.WebSearchConfiguration -> Azure.AI.Projects.Agents.WebSearchToolboxToolPublic Shared Function WebSearchToolboxTool (Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional filters As WebSearchToolFilters = Nothing, Optional userLocation As WebSearchToolApproximateLocation = Nothing, Optional searchContextSize As Nullable(Of WebSearchToolSearchContextSize) = Nothing, Optional customSearchConfiguration As WebSearchConfiguration = Nothing) As WebSearchToolboxToolParameters
- name
- String
Optional user-defined name for this tool or configuration.
- description
- String
Optional user-defined description for this tool or configuration.
- toolConfigs
- IDictionary<String,ToolConfig>
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.
- filters
- OpenAI.Responses.WebSearchToolFilters
- userLocation
- OpenAI.Responses.WebSearchToolApproximateLocation
- searchContextSize
- Nullable<WebSearchToolSearchContextSize>
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.
- customSearchConfiguration
- WebSearchConfiguration
The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.
Returns
A new WebSearchToolboxTool instance for mocking.
