Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

WithAISearchTool

Method
📦 Aspire.Hosting.Foundry v17.0.0-preview.1.26565.2
func (FoundryToolboxResource) WithAISearchTool(
name string,
search AzureSearchResource,
indexName string,
options ...*WithAISearchToolOptions,
) FoundryToolboxResource

Signature

methodWithAISearchToolbuilder
Adds an Azure AI Search tool definition to the Toolbox.
WithAISearchTool(
name string,
search AzureSearchResource,
indexName string,
options ...*WithAISearchToolOptions,
) FoundryToolboxResource
namestringThe tool name.
searchAzureSearchResourceThe Azure AI Search resource backing the tool.
indexNamestringThe search index name.
options...*WithAISearchToolOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithAISearchToolOptions argument.

Description*stringAn optional description of the Azure AI Search tool.
FoundryToolboxResource

The resource builder.

Returns a handle; failures surface later via Err().

Applies to

This method applies to the following types: