Class ToolSet

constructor

• new ToolSet(): ToolSet

• Returns ToolSet

toolDefinitions

toolResources

addAzureAISearchTool

• addAzureAISearchTool(indexConnectionId, indexName): {
      definition: AzureAISearchToolDefinition;
      resources: ToolResources;
  }

• Adds an Azure AI search tool to the tool set.

  Parameters

  • indexConnectionId: string

    The connection ID of the Azure AI search index.
  • indexName: string

    The name of the Azure AI search index.

  Returns {
      definition: AzureAISearchToolDefinition;
      resources: ToolResources;
  }

  An object containing the definition and resources for the Azure AI search tool

  • definition: AzureAISearchToolDefinition

  • resources: ToolResources

addBingGroundingTool

• addBingGroundingTool(searchConfigurations): {
      definition: BingGroundingToolDefinition;
  }

• Adds a bing grounding search tool to the tool set.

  Parameters

  • searchConfigurations: {}

  Returns {
      definition: BingGroundingToolDefinition;
  }

  An object containing the definition and resources for the bing grounding search tool

  • definition: BingGroundingToolDefinition

addCodeInterpreterTool

• addCodeInterpreterTool(fileIds?, dataSources?): {
      definition: CodeInterpreterToolDefinition;
      resources: ToolResources;
  }

• Adds a code interpreter tool to the tool set.

  Parameters

  • OptionalfileIds: {}

    A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.
  • OptionaldataSources: any

    The data sources to be used. This option is mutually exclusive with fileIds.

  Returns {
      definition: CodeInterpreterToolDefinition;
      resources: ToolResources;
  }

  An object containing the definition and resources for the code interpreter tool

  • definition: CodeInterpreterToolDefinition

  • resources: ToolResources

addConnectionTool

• addConnectionTool(toolType, connectionIds): {
      definition: ToolDefinition;
  }

• Adds a connection tool to the tool set.

  Parameters

  • toolType: connectionToolType

    The type of the connection tool.
  • connectionIds: {}

    A list of the IDs of the connections to use.

  Returns {
      definition: ToolDefinition;
  }

  An object containing the definition for the connection tool

  • definition: ToolDefinition

addFabricTool

• addFabricTool(connectionId): {
      definition: MicrosoftFabricToolDefinition;
  }

• Adds a Microsoft Fabric tool to the tool set.

  Parameters

  • connectionId: string

    The ID of the Fabric connection to use.

  Returns {
      definition: MicrosoftFabricToolDefinition;
  }

  An object containing the definition for the Microsoft Fabric tool

  • definition: MicrosoftFabricToolDefinition

addFileSearchTool

• addFileSearchTool(vectorStoreIds?, vectorStores?, definitionDetails?): {
      definition: FileSearchToolDefinition;
      resources: ToolResources;
  }

• Adds a file search tool to the tool set.

  Parameters

  • OptionalvectorStoreIds: {}

    The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.
  • OptionalvectorStores: any

    The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.
  • OptionaldefinitionDetails: FileSearchToolDefinitionDetails

    The input definition information for a file search tool as used to configure an agent.

  Returns {
      definition: FileSearchToolDefinition;
      resources: ToolResources;
  }

  An object containing the definition and resources for the file search tool

  • definition: FileSearchToolDefinition

  • resources: ToolResources

addOpenApiTool

• addOpenApiTool(openApiFunctionDefinition): {
      definition: OpenApiToolDefinition;
  }

• Adds an OpenApi tool to the tool set.

  Parameters

  • openApiFunctionDefinition: OpenApiFunctionDefinition

    The OpenApi function definition to use.

  Returns {
      definition: OpenApiToolDefinition;
  }

  An object containing the definition for the OpenApi tool

  • definition: OpenApiToolDefinition

addSharepointGroundingTool

• addSharepointGroundingTool(connectionId): {
      definition: SharepointToolDefinition;
  }

• Adds sharepoint grounding search tool to the tool set.

  Parameters

  • connectionId: string

    The ID of the sharepoint search connection.

  Returns {
      definition: SharepointToolDefinition;
  }

  An object containing the definition and resources for the sharepoint grounding search tool

  • definition: SharepointToolDefinition