ToolSet class

Paket:

@azure/ai-agents

Representerar en uppsättning verktyg med sina definitioner och resurser.

Egenskaper

toolDefinitions	En lista över verktygsdefinitioner som har lagts till i verktygsuppsättningen.
toolResources	En samling resurser som är associerade med verktygen i verktygsuppsättningen.

Metoder

addAzureAISearchTool(string, string)	Lägger till ett Azure AI-sökverktyg i verktygsuppsättningen.
addBingGroundingTool(BingGroundingSearchConfiguration[])	Lägger till ett sökverktyg för bing-jordning i verktygssatsen.
addCodeInterpreterTool(string[], VectorStoreDataSource[])	Lägger till ett kodtolkarverktyg i verktygsuppsättningen.
addConnectedAgentTool(string, string, string)	Lägger till ett verktyg för anslutna handläggare i verktygsuppsättningen.
addConnectionTool(connectionToolType, string[])	Lägger till ett anslutningsverktyg i verktygsuppsättningen.
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)	Lägger till ett filsökningsverktyg i verktygsuppsättningen.
addOpenApiTool(OpenApiFunctionDefinition)	Lägger till ett OpenApi-verktyg i verktygsuppsättningen.

Egenskapsinformation

toolDefinitions

En lista över verktygsdefinitioner som har lagts till i verktygsuppsättningen.

toolDefinitions: ToolDefinition[]

Egenskapsvärde

ToolDefinition[]

toolResources

En samling resurser som är associerade med verktygen i verktygsuppsättningen.

toolResources: ToolResources

Egenskapsvärde

ToolResources

Metodinformation

addAzureAISearchTool(string, string)

Lägger till ett Azure AI-sökverktyg i verktygsuppsättningen.

function addAzureAISearchTool(indexConnectionId: string, indexName: string): { definition: AzureAISearchToolDefinition, resources: ToolResources }

Parametrar

indexConnectionId

string

Anslutnings-ID för Azure AI-sökindexet.

indexName

string

Namnet på Azure AI-sökindexet.

Returer

{ definition: AzureAISearchToolDefinition, resources: ToolResources }

Ett objekt som innehåller definitionen och resurserna för Azure AI-sökverktyget

addBingGroundingTool(BingGroundingSearchConfiguration[])

Lägger till ett sökverktyg för bing-jordning i verktygssatsen.

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

Parametrar

searchConfigurations

BingGroundingSearchConfiguration[]

Returer

{ definition: BingGroundingToolDefinition }

Ett objekt som innehåller definitionen och resurserna för sökverktyget för jordning i Bing

addCodeInterpreterTool(string[], VectorStoreDataSource[])

Lägger till ett kodtolkarverktyg i verktygsuppsättningen.

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

Parametrar

fileIds

string[]

En lista över fil-ID:t som gjorts tillgängliga för code_interpreter verktyget. Det kan finnas högst 20 filer som är associerade med verktyget.

dataSources

VectorStoreDataSource[]

De datakällor som ska användas. Det här alternativet är ömsesidigt uteslutande med fileIds.

Returer

{ definition: CodeInterpreterToolDefinition, resources: ToolResources }

Ett objekt som innehåller definitionen och resurserna för kodtolkarverktyget

addConnectedAgentTool(string, string, string)

Lägger till ett verktyg för anslutna handläggare i verktygsuppsättningen.

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

Parametrar

id

string

ID:t för den anslutna agenten.

name

string

Namnet på den anslutna agenten.

description

string

Beskrivningen av den anslutna agenten.

Returer

{ definition: ConnectedAgentToolDefinition }

Ett objekt som innehåller definitionen för verktyget för den anslutna handläggaren

addConnectionTool(connectionToolType, string[])

Lägger till ett anslutningsverktyg i verktygsuppsättningen.

function addConnectionTool(toolType: connectionToolType, connectionIds: string[]): { definition: ToolDefinition }

Parametrar

toolType

connectionToolType

Anslutningsverktygets typ.

connectionIds

string[]

En lista över ID:t för de anslutningar som ska användas.

Returer

{ definition: ToolDefinition }

Ett objekt som innehåller definitionen för anslutningsverktyget

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

Lägger till ett filsökningsverktyg i verktygsuppsättningen.

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

Parametrar

vectorStoreIds

string[]

ID:t för vektorarkivet som är kopplat till den här agenten. Det kan finnas ett maximalt 1 vektorlager kopplat till agenten.

vectorStores

VectorStoreConfigurations[]

Listan över konfigurationsobjekt för vektorlager från Azure. Den här listan är begränsad till ett element. Det enda elementet i den här listan innehåller listan över azure-tillgångs-ID:t som används av sökverktyget.

definitionDetails

FileSearchToolDefinitionDetails

Information om indatadefinitionen för ett filsökningsverktyg som används för att konfigurera en agent.

Returer

{ definition: FileSearchToolDefinition, resources: ToolResources }

Ett objekt som innehåller definitionen och resurserna för filsökningsverktyget

addOpenApiTool(OpenApiFunctionDefinition)

Lägger till ett OpenApi-verktyg i verktygsuppsättningen.

function addOpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition): { definition: OpenApiToolDefinition }

Parametrar

openApiFunctionDefinition

OpenApiFunctionDefinition

OpenApi-funktionsdefinitionen som ska användas.

Returer

{ definition: OpenApiToolDefinition }

Ett objekt som innehåller definitionen för OpenApi-verktyget