ToolSet class
定義とリソースを含む一連のツールを表します。
プロパティ
| tool |
ツール セットに追加されたツール定義の一覧。 |
| tool |
ツール セット内のツールに関連付けられているリソースのコレクション。 |
メソッド
| add |
Azure AI 検索ツールをツール セットに追加します。 |
| add |
Bing 接地検索ツールをツール セットに追加します。 |
| add |
コード インタープリター ツールをツール セットに追加します。 |
| add |
接続されたエージェント ツールをツール セットに追加します。 |
| add |
接続ツールをツール セットに追加します。 |
| add |
ファイル検索ツールをツール セットに追加します。 |
| add |
OpenApi ツールをツール セットに追加します。 |
プロパティの詳細
toolDefinitions
toolResources
メソッドの詳細
addAzureAISearchTool(string, string)
Azure AI 検索ツールをツール セットに追加します。
function addAzureAISearchTool(indexConnectionId: string, indexName: string): { definition: AzureAISearchToolDefinition, resources: ToolResources }パラメーター
- indexConnectionId
-
string
Azure AI 検索インデックスの接続 ID。
- indexName
-
string
Azure AI 検索インデックスの名前。
戻り値
{ definition: AzureAISearchToolDefinition, resources: ToolResources }
Azure AI 検索ツールの定義とリソースを含むオブジェクト
addBingGroundingTool(BingGroundingSearchConfiguration[])
Bing 接地検索ツールをツール セットに追加します。
function addBingGroundingTool(searchConfigurations: BingGroundingSearchConfiguration[]): { definition: BingGroundingToolDefinition }パラメーター
- searchConfigurations
戻り値
{ definition: BingGroundingToolDefinition }
Bing 接地検索ツールの定義とリソースを含むオブジェクト
addCodeInterpreterTool(string[], VectorStoreDataSource[])
コード インタープリター ツールをツール セットに追加します。
function addCodeInterpreterTool(fileIds?: string[], dataSources?: VectorStoreDataSource[]): { definition: CodeInterpreterToolDefinition, resources: ToolResources }パラメーター
- fileIds
-
string[]
code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
- dataSources
使用するデータ ソース。 このオプションは fileIds と相互に排他的です。
戻り値
{ definition: CodeInterpreterToolDefinition, resources: ToolResources }
コード インタープリター ツールの定義とリソースを含むオブジェクト
addConnectedAgentTool(string, string, string)
接続されたエージェント ツールをツール セットに追加します。
function addConnectedAgentTool(id: string, name: string, description: string): { definition: ConnectedAgentToolDefinition }パラメーター
- id
-
string
接続されているエージェントの ID。
- name
-
string
接続されているエージェントの名前。
- description
-
string
接続されたエージェントの説明。
戻り値
{ definition: ConnectedAgentToolDefinition }
接続されたエージェント ツールの定義を含むオブジェクト
addConnectionTool(connectionToolType, string[])
接続ツールをツール セットに追加します。
function addConnectionTool(toolType: connectionToolType, connectionIds: string[]): { definition: ToolDefinition }パラメーター
- toolType
- connectionToolType
接続ツールの種類。
- connectionIds
-
string[]
使用する接続の ID の一覧。
戻り値
{ definition: ToolDefinition }
接続ツールの定義を含むオブジェクト
addFileSearchTool(string[], VectorStoreConfigurations[], FileSearchToolDefinitionDetails)
ファイル検索ツールをツール セットに追加します。
function addFileSearchTool(vectorStoreIds?: string[], vectorStores?: VectorStoreConfigurations[], definitionDetails?: FileSearchToolDefinitionDetails): { definition: FileSearchToolDefinition, resources: ToolResources }パラメーター
- vectorStoreIds
-
string[]
このエージェントにアタッチされているベクター ストアの ID。 エージェントには、最大 1 つのベクター ストアをアタッチできます。
- vectorStores
Azure からのベクター ストア構成オブジェクトの一覧。 このリストは 1 つの要素に制限されています。 この一覧の唯一の要素には、検索ツールで使用される Azure 資産 ID の一覧が含まれています。
- definitionDetails
- FileSearchToolDefinitionDetails
エージェントの構成に使用されるファイル検索ツールの入力定義情報。
戻り値
{ definition: FileSearchToolDefinition, resources: ToolResources }
ファイル検索ツールの定義とリソースを含むオブジェクト
addOpenApiTool(OpenApiFunctionDefinition)
OpenApi ツールをツール セットに追加します。
function addOpenApiTool(openApiFunctionDefinition: OpenApiFunctionDefinition): { definition: OpenApiToolDefinition }パラメーター
- openApiFunctionDefinition
- OpenApiFunctionDefinition
使用する OpenApi 関数定義。
戻り値
{ definition: OpenApiToolDefinition }
OpenApi ツールの定義を含むオブジェクト