ExtensionsOpenAIModelFactory.ResponsesWebSearchTool 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.
Web search.
public static Azure.AI.Extensions.OpenAI.ResponsesWebSearchTool ResponsesWebSearchTool(Azure.AI.Extensions.OpenAI.WebSearchToolFilters filters = default, Azure.AI.Extensions.OpenAI.ResponsesWebSearchApproximateLocation userLocation = default, Azure.AI.Extensions.OpenAI.ResponsesWebSearchToolSearchContextSize? searchContextSize = default, string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Extensions.OpenAI.ToolConfig> toolConfigs = default, Azure.AI.Extensions.OpenAI.ResponsesWebSearchConfiguration customSearchConfiguration = default);static member ResponsesWebSearchTool : Azure.AI.Extensions.OpenAI.WebSearchToolFilters * Azure.AI.Extensions.OpenAI.ResponsesWebSearchApproximateLocation * Nullable<Azure.AI.Extensions.OpenAI.ResponsesWebSearchToolSearchContextSize> * string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Extensions.OpenAI.ToolConfig> * Azure.AI.Extensions.OpenAI.ResponsesWebSearchConfiguration -> Azure.AI.Extensions.OpenAI.ResponsesWebSearchToolPublic Shared Function ResponsesWebSearchTool (Optional filters As WebSearchToolFilters = Nothing, Optional userLocation As ResponsesWebSearchApproximateLocation = Nothing, Optional searchContextSize As Nullable(Of ResponsesWebSearchToolSearchContextSize) = Nothing, Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional customSearchConfiguration As ResponsesWebSearchConfiguration = Nothing) As ResponsesWebSearchToolParameters
- filters
- WebSearchToolFilters
- userLocation
- ResponsesWebSearchApproximateLocation
- searchContextSize
- Nullable<ResponsesWebSearchToolSearchContextSize>
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.
- name
- String
Deprecated. This property is deprecated and will be removed in a future version.
- description
- String
Deprecated. This property is deprecated and will be removed in a future version.
- toolConfigs
- IDictionary<String,ToolConfig>
Deprecated. This property is deprecated and will be removed in a future version.
- customSearchConfiguration
- ResponsesWebSearchConfiguration
The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.
Returns
A new ResponsesWebSearchTool instance for mocking.
