ProjectsAgentsModelFactory.FileSearchToolboxTool 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 file search tool stored in a toolbox.
public static Azure.AI.Projects.Agents.FileSearchToolboxTool FileSearchToolboxTool(string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Extensions.OpenAI.ToolConfig> toolConfigs = default, long? maxNumResults = default, object rankingOptions = default, BinaryData filters = default, System.Collections.Generic.IEnumerable<string> vectorStoreIds = default);static member FileSearchToolboxTool : string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Extensions.OpenAI.ToolConfig> * Nullable<int64> * obj * BinaryData * seq<string> -> Azure.AI.Projects.Agents.FileSearchToolboxToolPublic Shared Function FileSearchToolboxTool (Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional maxNumResults As Nullable(Of Long) = Nothing, Optional rankingOptions As Object = Nothing, Optional filters As BinaryData = Nothing, Optional vectorStoreIds As IEnumerable(Of String) = Nothing) As FileSearchToolboxToolParameters
- 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.
The maximum number of results to return. This number should be between 1 and 50 inclusive.
- rankingOptions
- Object
Ranking options for search.
- filters
- BinaryData
- vectorStoreIds
- IEnumerable<String>
The IDs of the vector stores to search.
Returns
A new FileSearchToolboxTool instance for mocking.
