ToolUtility class

Пакет:

@azure/ai-agents

Класс служебной программы для создания различных инструментов.

Методы

createAzureAISearchTool(string, string, AISearchIndexResource)	Создание средства поиска по искусственному интеллекту Azure
createBingGroundingTool(BingGroundingSearchConfiguration[])	Создание инструмента поиска заземления Bing
createBrowserAutomationTool(string)	Создание средства автоматизации браузера
createCodeInterpreterTool(string[], VectorStoreDataSource[])	Создание средства интерпретатора кода
createConnectedAgentTool(string, string, string)	Создает инструмент подключенного агента
createConnectionTool(connectionToolType, string[])	Создание средства подключения
createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Создает средство поиска файлов
createFunctionTool(FunctionDefinition)	Создание средства функции
createMCPTool({ allowedTools?: string[], serverLabel: string, serverUrl: string })	Создает инструмент MCP с предоставленной конфигурацией.
createOpenApiTool(OpenApiFunctionDefinition)	Создает средство OpenApi

Сведения о методе

createAzureAISearchTool(string, string, AISearchIndexResource)

Создание средства поиска по искусственному интеллекту Azure

static function createAzureAISearchTool(indexConnectionId: string, indexName: string, options?: AISearchIndexResource): { definition: AzureAISearchToolDefinition, resources: ToolResources }

Параметры

indexConnectionId

string

Идентификатор подключения индекса поиска Azure AI.

indexName

string

Имя индекса поиска ИИ Azure.

options

AISearchIndexResource

Возвращаемое значение

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Объект, содержащий определение и ресурсы для средства поиска ИИ Azure.

createBingGroundingTool(BingGroundingSearchConfiguration[])

Создание инструмента поиска заземления Bing

static function createBingGroundingTool(searchConfigurations: BingGroundingSearchConfiguration[]): { definition: BingGroundingToolDefinition }

Параметры

searchConfigurations

BingGroundingSearchConfiguration[]

Возвращаемое значение

{ definition: BingGroundingToolDefinition }

Объект, содержащий определение и ресурсы для средства поиска заземления bing

createBrowserAutomationTool(string)

Создание средства автоматизации браузера

static function createBrowserAutomationTool(connectionId: string): { definition: BrowserAutomationToolDefinition }

Параметры

connectionId

string

Идентификатор подключения к службе Azure Playwright, который будет использоваться средством.

Возвращаемое значение

{ definition: BrowserAutomationToolDefinition }

Объект, содержащий определение для средства автоматизации браузера.

createCodeInterpreterTool(string[], VectorStoreDataSource[])

Создание средства интерпретатора кода

static function createCodeInterpreterTool(fileIds?: string[], dataSources?: VectorStoreDataSource[]): { definition: CodeInterpreterToolDefinition, resources: ToolResources }

Параметры

fileIds

string[]

Список идентификаторов файлов, доступных средству code_interpreter . С инструментом может быть не более 20 файлов.

dataSources

VectorStoreDataSource[]

Используемые источники данных. Этот параметр является взаимоисключающим с fileIds.

Возвращаемое значение

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Объект, содержащий определение и ресурсы для средства интерпретатора кода.

createConnectedAgentTool(string, string, string)

Создает инструмент подключенного агента

static function createConnectedAgentTool(id: string, name: string, description: string): { definition: ConnectedAgentToolDefinition }

Параметры

id

string

name

string

description

string

Возвращаемое значение

{ definition: ConnectedAgentToolDefinition }

Объект, содержащий определение для подключенного агента.

createConnectionTool(connectionToolType, string[])

Создание средства подключения

static function createConnectionTool(toolType: connectionToolType, connectionIds: string[]): { definition: ToolDefinitionUnion }

Параметры

toolType

connectionToolType

Тип средства подключения.

connectionIds

string[]

Список идентификаторов используемых подключений.

Возвращаемое значение

{ definition: ToolDefinitionUnion }

Объект, содержащий определение для средства подключения

createFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)

Создает средство поиска файлов

static function createFileSearchTool(vectorStoreIds?: string[], vectorStores?: VectorStoreConfigurations[], definitionDetails?: FileSearchToolDefinitionDetails): { definition: FileSearchToolDefinition, resources: ToolResources }

Параметры

vectorStoreIds

string[]

Идентификатор хранилища векторов, присоединенного к этому агенту. К агенту может быть подключено не более 1 векторного хранилища.

vectorStores

VectorStoreConfigurations[]

Список объектов конфигурации хранилища векторов из Azure. Этот список ограничен одним элементом. Единственный элемент этого списка содержит список идентификаторов активов Azure, используемых средством поиска.

definitionDetails

FileSearchToolDefinitionDetails

Сведения об определении входных данных для средства поиска файлов, используемых для настройки агента.

Возвращаемое значение

{ definition: FileSearchToolDefinition, resources: ToolResources }

Объект, содержащий определение и ресурсы для средства поиска файлов

createFunctionTool(FunctionDefinition)

Создание средства функции

static function createFunctionTool(functionDefinition: FunctionDefinition): { definition: FunctionToolDefinition }

Параметры

functionDefinition

FunctionDefinition

Определение функции, используемое.

Возвращаемое значение

{ definition: FunctionToolDefinition }

Объект, содержащий определение для средства функции.

createMCPTool({ allowedTools?: string[], serverLabel: string, serverUrl: string })

Создает инструмент MCP с предоставленной конфигурацией.

static function createMCPTool(options: { allowedTools?: string[], serverLabel: string, serverUrl: string }): MCPTool

Параметры

options

{ allowedTools?: string[], serverLabel: string, serverUrl: string }

Варианты конфигурации для инструмента MCP

Возвращаемое значение

MCPTool

Новый экземпляр MCPTool

createOpenApiTool(OpenApiFunctionDefinition)

Создает средство OpenApi

static function createOpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition): { definition: OpenApiToolDefinition }

Параметры

openApiFunctionDefinition

OpenApiFunctionDefinition

Определение функции OpenApi для использования.

Возвращаемое значение

{ definition: OpenApiToolDefinition }

Объект, содержащий определение средства OpenApi.