Package version:

Class ToolUtility

Utility class for creating various tools.

Index

Constructors

Methods

createAzureAISearchTool createBingCustomSearchTool createBingGroundingTool createCodeInterpreterTool createConnectionTool createFabricTool createFileSearchTool createFunctionTool createOpenApiTool createSharepointGroundingTool

Constructors

constructor

new ToolUtility(): ToolUtility
Returns ToolUtility

Methods

`Static`createAzureAISearchTool

createAzureAISearchTool(indexConnectionId, indexName, options?): {
definition: AzureAISearchToolDefinition;
resources: ToolResources;
}
Creates an Azure AI search tool
Parameters
- indexConnectionId: string
  The connection ID of the Azure AI search index.
- indexName: string
  The name of the Azure AI search index.
- Optionaloptions: AISearchIndexResource
Returns {
definition: AzureAISearchToolDefinition;
resources: ToolResources;
}
An object containing the definition and resources for the Azure AI search tool.
- definition: AzureAISearchToolDefinition
- resources: ToolResources
- Defined in utils.ts:217

`Static`createBingCustomSearchTool

createBingCustomSearchTool(searchConfigurations): {
definition: BingCustomSearchToolDefinition;
}
Creates a bing custom search tool
Parameters
- searchConfigurations: {}
  The ID of bing search connection and instanceName.
Returns {
definition: BingCustomSearchToolDefinition;
}
An object containing the definition and resources for the bing custom search tool
- definition: BingCustomSearchToolDefinition
- Defined in utils.ts:151

`Static`createBingGroundingTool

createBingGroundingTool(searchConfigurations): {
definition: BingGroundingToolDefinition;
}
Creates a bing grounding search tool
Parameters
- searchConfigurations: {}
Returns {
definition: BingGroundingToolDefinition;
}
An object containing the definition and resources for the bing grounding search tool
- definition: BingGroundingToolDefinition
- Defined in utils.ts:124

`Static`createCodeInterpreterTool

createCodeInterpreterTool(fileIds?, dataSources?): {
definition: CodeInterpreterToolDefinition;
resources: ToolResources;
}
Creates a code interpreter tool
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
- Defined in utils.ts:195

`Static`createConnectionTool

createConnectionTool(toolType, connectionIds): {
definition: ToolDefinitionUnion;
}
Creates a connection tool
Parameters
- toolType: connectionToolType
  The type of the connection tool.
- connectionIds: {}
  A list of the IDs of the connections to use.
Returns {
definition: ToolDefinitionUnion;
}
An object containing the definition for the connection tool
- definition: ToolDefinitionUnion
- Defined in utils.ts:77

`Static`createFabricTool

createFabricTool(connectionId): {
definition: MicrosoftFabricToolDefinition;
}
Creates a Microsoft Fabric tool
Parameters
- connectionId: string
Returns {
definition: MicrosoftFabricToolDefinition;
}
An object containing the definition for the Microsoft Fabric tool
- definition: MicrosoftFabricToolDefinition
- Defined in utils.ts:246

`Static`createFileSearchTool

createFileSearchTool(vectorStoreIds?, vectorStores?, definitionDetails?): {
definition: FileSearchToolDefinition;
resources: ToolResources;
}
Creates a file search tool
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
- Defined in utils.ts:176

`Static`createFunctionTool

createFunctionTool(functionDefinition): {
definition: FunctionToolDefinition;
}
Creates a function tool
Parameters
- functionDefinition: FunctionDefinition
  The function definition to use.
Returns {
definition: FunctionToolDefinition;
}
An object containing the definition for the function tool.
- definition: FunctionToolDefinition
- Defined in utils.ts:264

`Static`createOpenApiTool

createOpenApiTool(openApiFunctionDefinition): {
definition: OpenApiToolDefinition;
}
Creates an OpenApi tool
Parameters
- openApiFunctionDefinition: OpenApiFunctionDefinition
  The OpenApi function definition to use.
Returns {
definition: OpenApiToolDefinition;
}
An object containing the definition for the OpenApi tool.
- definition: OpenApiToolDefinition
- Defined in utils.ts:282

`Static`createSharepointGroundingTool

createSharepointGroundingTool(connectionId): {
definition: SharepointToolDefinition;
}
Creates a sharepoint grounding search tool
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
- Defined in utils.ts:99

Class ToolUtility

Index

Constructors

Methods

Constructors

constructor

Returns ToolUtility

Methods

StaticcreateAzureAISearchTool

Parameters

Returns { definition: AzureAISearchToolDefinition; resources: ToolResources; }

definition: AzureAISearchToolDefinition

resources: ToolResources

StaticcreateBingCustomSearchTool

Parameters

Returns { definition: BingCustomSearchToolDefinition; }

definition: BingCustomSearchToolDefinition

StaticcreateBingGroundingTool

Parameters

Returns { definition: BingGroundingToolDefinition; }

definition: BingGroundingToolDefinition

StaticcreateCodeInterpreterTool

Parameters

Returns { definition: CodeInterpreterToolDefinition; resources: ToolResources; }

definition: CodeInterpreterToolDefinition

resources: ToolResources

StaticcreateConnectionTool

Parameters

Returns { definition: ToolDefinitionUnion; }

definition: ToolDefinitionUnion

StaticcreateFabricTool

Parameters

Returns { definition: MicrosoftFabricToolDefinition; }

definition: MicrosoftFabricToolDefinition

StaticcreateFileSearchTool

Parameters

Returns { definition: FileSearchToolDefinition; resources: ToolResources; }

definition: FileSearchToolDefinition

resources: ToolResources

StaticcreateFunctionTool

Parameters

Returns { definition: FunctionToolDefinition; }

definition: FunctionToolDefinition

StaticcreateOpenApiTool

Parameters

Returns { definition: OpenApiToolDefinition; }

definition: OpenApiToolDefinition

StaticcreateSharepointGroundingTool

Parameters

Returns { definition: SharepointToolDefinition; }

definition: SharepointToolDefinition

Settings

`Static`createAzureAISearchTool

Returns {
definition: AzureAISearchToolDefinition;
resources: ToolResources;
}

`Static`createBingCustomSearchTool

Returns {
definition: BingCustomSearchToolDefinition;
}

`Static`createBingGroundingTool

Returns {
definition: BingGroundingToolDefinition;
}

`Static`createCodeInterpreterTool

Returns {
definition: CodeInterpreterToolDefinition;
resources: ToolResources;
}

`Static`createConnectionTool

Returns {
definition: ToolDefinitionUnion;
}

`Static`createFabricTool

Returns {
definition: MicrosoftFabricToolDefinition;
}

`Static`createFileSearchTool

Returns {
definition: FileSearchToolDefinition;
resources: ToolResources;
}

`Static`createFunctionTool

Returns {
definition: FunctionToolDefinition;
}

`Static`createOpenApiTool

Returns {
definition: OpenApiToolDefinition;
}

`Static`createSharepointGroundingTool

Returns {
definition: SharepointToolDefinition;
}