FoundryAITool.CreateFileSearchTool Method

Definition

Namespace:

Microsoft.Agents.AI.AzureAI

Assembly:

Microsoft.Agents.AI.AzureAI.dll

Package:

Microsoft.Agents.AI.AzureAI v1.0.0-rc5

Creates an AITool for file search over vector stores.

public static Microsoft.Extensions.AI.AITool CreateFileSearchTool(System.Collections.Generic.IEnumerable<string> vectorStoreIds, int? maxResultCount = default, OpenAI.Responses.FileSearchToolRankingOptions? rankingOptions = default, BinaryData? filters = default);

static member CreateFileSearchTool : seq<string> * Nullable<int> * OpenAI.Responses.FileSearchToolRankingOptions * BinaryData -> Microsoft.Extensions.AI.AITool

Public Shared Function CreateFileSearchTool (vectorStoreIds As IEnumerable(Of String), Optional maxResultCount As Nullable(Of Integer) = Nothing, Optional rankingOptions As FileSearchToolRankingOptions = Nothing, Optional filters As BinaryData = Nothing) As AITool

Parameters

vectorStoreIds

IEnumerable<String>

The IDs of vector stores to search.

maxResultCount

Nullable<Int32>

Optional maximum number of results to return.

rankingOptions

OpenAI.Responses.FileSearchToolRankingOptions

Optional ranking options for search results.

filters

BinaryData

Optional filters for search results.

Returns

AITool

An AITool for file search.