AIエージェントの更新
AIエージェントの更新
PUT /2.0/ai_agents/{id}
エンドポイントを使用すると、IDに基づいてカスタムAIエージェントを更新できます。
リクエストの送信
リクエストを送信するには、PUT /2.0/ai_agents/{id}
エンドポイントを使用します。
cURL
curl -i -X PUT "https://api.box.com/2.0/ai_agents/1234567890" \
-H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.aiStudio.updateAiAgentById(createdAgent.id, {
name: agentName,
accessState: 'enabled',
ask: new AiStudioAgentAsk({ accessState: 'disabled', description: 'desc2' }),
} satisfies CreateAiAgentInput);
Python Gen
client.ai_studio.update_ai_agent_by_id(
created_agent.id,
agent_name,
"enabled",
ask=AiStudioAgentAsk(access_state="disabled", description="desc2"),
)
.NET Gen
await client.AiStudio.UpdateAiAgentByIdAsync(agentId: createdAgent.Id, requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "disabled", description: "desc2") });
パラメータ
コールを実行するには、以下のパラメータを渡す必要があります。必須のパラメータは太字で示されています。
パラメータ | 説明 | 例 |
---|---|---|
type | クエリの処理に使用されるエージェントのタイプ。 | ```` |
name | AIエージェントの名前。 | マイAIエージェント |
access_state | AIエージェントの状態。値はenabled 、disabled のいずれかです。 | enabled |
icon_reference | AIエージェントのアイコン参照。これは、URL https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name> の形式で指定する必要があります。この場合、file_name に使用可能な値はlogo_boxAi.png 、logo_stamp.png 、logo_legal.png 、logo_finance.png 、logo_config.png 、logo_handshake.png 、logo_analytics.png 、logo_classification.png です。 | https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg |
allowed_entities | 許可するユーザーまたはグループのリスト。 | |
ask | 質問に使用されるAIエージェント。 | ask |
extract | 抽出に使用されるAIエージェント。 | |
text_gen | テキストの生成に使用されるAIエージェント。 |