Aspire.Hosting.Foundry
Official
📦 Aspire.Hosting.Foundry v13.3.0-preview.1.26254.5 34 Functions
21 Types
21 types and 34 members
Types
handle
AzureAISearchToolResource 1 members handle
AzureCognitiveServicesProjectConnectionResource handle
AzureCognitiveServicesProjectResource 25 members handle
AzureFunctionToolResource handle
AzurePromptAgentResource 10 members handle
BingGroundingConnectionResource handle
BingGroundingToolResource 1 members handle
CodeInterpreterToolResource handle
ComputerToolResource handle
FabricToolResource handle
FileSearchToolResource handle
FoundryDeploymentResource 16 members type
FoundryModel 3 fields handle
FoundryResource 3 members handle
FoundryToolResource handle
FunctionToolResource handle
HostedAgentConfiguration 10 members handle
ImageGenerationToolResource handle
SharePointToolResource handle
WebSearchToolResource Functions
method
addAISearchTool builder Adds an Azure AI Search tool to a Microsoft Foundry project.
addAISearchTool(name: string, indexName?: string): AzureAISearchToolResource method
addAzureFunctionTool builder Adds an Azure Function tool to a Microsoft Foundry project.
addAzureFunctionTool(name: string, functionName: string, description: string, parametersJson: string, inputQueueEndpoint: string, inputQueueName: string, outputQueueEndpoint: string, outputQueueName: string): AzureFunctionToolResource method
addBingGroundingConnection builder Adds a Grounding with Bing Search connection to a Microsoft Foundry project.
addBingGroundingConnection(name: string, bingResourceId: string): BingGroundingConnectionResource method
addBingGroundingConnectionFromParameter builder Adds a Grounding with Bing Search connection to a Microsoft Foundry project using a parameter.
addBingGroundingConnectionFromParameter(name: string, bingResourceId: ParameterResource): BingGroundingConnectionResource method
addBingGroundingTool builder Adds a Bing Grounding tool to a Microsoft Foundry project.
addBingGroundingTool(name: string): BingGroundingToolResource method
addCapabilityHost builder Adds a capability host to a Microsoft Foundry project.
addCapabilityHost(name: string): AzureCognitiveServicesProjectResource method
addCodeInterpreterTool builder Adds a Code Interpreter tool to a Microsoft Foundry project.
addCodeInterpreterTool(name: string): CodeInterpreterToolResource method
addComputerUseTool builder Adds a Computer Use tool to a Microsoft Foundry project.
addComputerUseTool(name: string, displayWidth?: number, displayHeight?: number, environment?: string): ComputerToolResource method
addConnection builder Adds a connection to a Microsoft Foundry project.
addConnection(resource: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource method
addContainerRegistryConnection builder Adds an Azure Container Registry connection to a Microsoft Foundry project.
addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResource method
addCosmosConnection builder Adds an Azure Cosmos DB connection to a Microsoft Foundry project.
addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResource method
addDeployment builder Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.
addDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource method
addFabricTool builder Adds a Microsoft Fabric data agent tool to a Microsoft Foundry project.
addFabricTool(name: string, projectConnectionIds: string[]): FabricToolResource method
addFileSearchTool builder Adds a File Search tool to a Microsoft Foundry project.
addFileSearchTool(name: string, vectorStoreIds: string[]): FileSearchToolResource method
addFoundry builder Adds a Microsoft Foundry resource to the distributed application model.
addFoundry(name: string): FoundryResource method
addFunctionTool builder Adds a function calling tool to a Microsoft Foundry project.
addFunctionTool(name: string, functionName: string, parametersJson: string, description?: string, strictModeEnabled?: boolean): FunctionToolResource method
addImageGenerationTool builder Adds an Image Generation tool to a Microsoft Foundry project.
addImageGenerationTool(name: string): ImageGenerationToolResource method
addKeyVaultConnection builder Adds an Azure Key Vault connection to a Microsoft Foundry project.
addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource method
addModelDeployment builder Adds a model deployment to the parent Microsoft Foundry resource.
addModelDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource method
addProject builder Adds a Microsoft Foundry project resource to a Microsoft Foundry resource.
addProject(name: string): AzureCognitiveServicesProjectResource method
addPromptAgent builder Adds a prompt agent to a Microsoft Foundry project.
addPromptAgent(model: FoundryDeploymentResource, name: string, instructions?: string): AzurePromptAgentResource method
addSearchConnection builder Adds an Azure AI Search connection to a Microsoft Foundry project.
addSearchConnection(search: AzureSearchResource): AzureCognitiveServicesProjectConnectionResource method
addSharePointTool builder Adds a SharePoint grounding tool to a Microsoft Foundry project.
addSharePointTool(name: string, projectConnectionIds: string[]): SharePointToolResource method
addStorageConnection builder Adds an Azure Storage connection to a Microsoft Foundry project.
addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResource method
addWebSearchTool builder Adds a Web Search tool to a Microsoft Foundry project.
addWebSearchTool(name: string): WebSearchToolResource method
publishAsHostedAgent builder Publishes an executable resource as a hosted agent in Microsoft Foundry.
publishAsHostedAgent(project?: AzureCognitiveServicesProjectResource, configure?: (obj: HostedAgentConfiguration) => Promise<void>): IResourceWithEndpoints method
runAsFoundryLocal builder Configures the Microsoft Foundry resource to run by using Foundry Local.
runAsFoundryLocal(): FoundryResource method
withAppInsights builder Associates an Azure Application Insights resource with a Microsoft Foundry project.
withAppInsights(appInsights: AzureApplicationInsightsResource): AzureCognitiveServicesProjectResource method
withCapabilityHost builder Associates a supported resource with a capability host on a Microsoft Foundry project.
withCapabilityHost(resource: FoundryResource): AzureCognitiveServicesProjectResource method
withKeyVault builder Associates an Azure Key Vault resource with a Microsoft Foundry project.
withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResource method
withProperties builder Configures properties of a Microsoft Foundry deployment resource.
withProperties(configure: (obj: FoundryDeploymentResource) => Promise<void>): FoundryDeploymentResource method
withReference builder Links an Azure AI Search tool to a backing search resource.
withReference(search: AzureSearchResource): AzureAISearchToolResource method
withReference builder Links a Bing Grounding tool to a Bing Search resource or connection.
withReference(bingReference: ParameterResource): BingGroundingToolResource method
withTool builder Adds a tool to a prompt agent.
withTool(tool: FoundryToolResource): AzurePromptAgentResource