Box Developerドキュメント
ログイン

Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。

最新バージョン

AIエージェントを作成

post
https://api.box.com/2.0
/ai_agents

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

AIエージェントを作成します。ask、text_gen、extractの機能のうち1つ以上を指定する必要があります。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

string本文内必須
"ai_agent"

クエリの処理に使用されるエージェントのタイプ。

次の値に固定: ai_agent

string本文内必須
"enabled"

AIエージェントの状態。使用可能な値はenabled、disabled、enabled_for_selected_usersです。

タイプとIDが指定されたエンティティ [ グループ (Base) / ユーザー (Base) ] array本文内省略可能

許可するユーザーまたはグループのリスト。

AIエージェントの機能 (質問リクエスト) object本文内

クエリの処理に使用するAIエージェント。

AIエージェントの機能 (抽出リクエスト) object本文内

メタデータ抽出に使用するAIエージェント。

string本文内省略可能
"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"

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です。

string本文内必須
"My AI Agent"

AIエージェントの名前。

AIエージェントの機能 (テキスト生成リクエスト) object本文内

テキストの生成に使用するAIエージェント。

レスポンス

application/jsonAIエージェント (Full)

作成されたAIエージェントの定義。

application/jsonクライアントエラー

予期しないクライアントエラー。

application/jsonクライアントエラー

予期しないサーバーエラー。

post
AIエージェントを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


Node/TypeScript v10
await client.aiStudio.createAiAgent({
  name: agentName,
  accessState: 'enabled',
  ask: new AiStudioAgentAsk({ accessState: 'enabled', description: 'desc1' }),
} satisfies CreateAiAgentInput);
Python v10
client.ai_studio.create_ai_agent(
    agent_name,
    "enabled",
    ask=AiStudioAgentAsk(access_state="enabled", description="desc1"),
)
.NET v10
await client.AiStudio.CreateAiAgentAsync(requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "enabled", description: "desc1") });
Swift v10
try await client.aiStudio.createAiAgent(requestBody: CreateAiAgent(name: agentName, accessState: "enabled", ask: AiStudioAgentAsk(accessState: "enabled", description: "desc1")))
Java v10
client.getAiStudio().createAiAgent(new CreateAiAgent.Builder(agentName, "enabled").ask(new AiStudioAgentAsk("enabled", "desc1")).build())
.NET v6
await client.AiStudio.CreateAiAgentAsync(requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "enabled", description: "desc1") });
Node v4
await client.aiStudio.createAiAgent({
  name: agentName,
  accessState: 'enabled',
  ask: new AiStudioAgentAsk({ accessState: 'enabled', description: 'desc1' }),
} satisfies CreateAiAgentInput);

レスポンスの例

{
  "id": "1234567890",
  "type": "ai_agent",
  "access_state": "enabled",
  "allowed_entities": [
    {
      "id": "11446498",
      "type": "user"
    }
  ],
  "ask": {
    "type": "ai_agent_ask",
    "access_state": "enabled",
    "basic_image": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_image_multi": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text_multi": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "long_text": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "long_text_multi": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "spreadsheet": {
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "suggested_questions": [
      "What is in this file?",
      "What are the main highlights of this document?"
    ]
  },
  "created_at": "2022-01-01T00:00:00Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "extract": {
    "type": "ai_agent_extract",
    "access_state": "enabled",
    "basic_image": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "basic_text": {
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "long_text": {
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    }
  },
  "icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
  "modified_at": "2022-01-01T00:00:00Z",
  "modified_by": {
    "id": "11446498",
    "type": "user"
  },
  "name": "This is my Agent",
  "origin": "CUSTOM",
  "text_gen": {
    "type": "ai_agent_text_gen",
    "access_state": "enabled",
    "basic_gen": {
      "content_template": "---{content}---",
      "embeddings": {
        "model": "azure__openai__text_embedding_ada_002",
        "strategy": {
          "id": "basic",
          "num_tokens_per_chunk": 64
        }
      },
      "is_custom_instructions_included": false,
      "llm_endpoint_params": {
        "type": "openai_params",
        "frequency_penalty": 1.5,
        "presence_penalty": 1.5,
        "stop": "<|im_end|>",
        "temperature": 0,
        "top_p": 1
      },
      "model": "azure__openai__gpt_4o_mini",
      "num_tokens_for_completion": 8400,
      "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
      "system_message": "You are a helpful travel assistant specialized in budget travel",
      "warnings": [
        "MODEL_INACTIVE"
      ]
    },
    "custom_instructions": "This is a custom instruction",
    "description": "This is ASK Agent",
    "suggested_questions": [
      "What is in this file?",
      "What are the main highlights of this document?"
    ]
  }
}