AIへの質問リクエストを送信

post
https://api.box.com/2.0
/ai/ask

サポートされているLLMにAIリクエストを送信し、提供されたコンテキストを考慮してユーザーの質問に特化した回答を返します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

object array本文内必須

LLMで処理する項目 (多くの場合はファイル)。

string本文内必須
"123"

項目のID

string本文内必須
"file"

項目のタイプ

次の値に固定: file

string本文内省略可能
"This is file content."

項目のコンテンツ (多くの場合はテキストレプリゼンテーション)。

string本文内必須
"multiple_item_qa"

このモードでは、このリクエストが1つの項目を対象とするか複数の項目を対象とするかを指定します。

次の値のいずれか1つ: multiple_item_qa,single_item_qa

string本文内必須
"What is the value provided by public APIs based on this document?"

LLMが回答できるようにクライアントが提供したプロンプト。

レスポンス

application/jsonAIの応答

LLMからの回答を含む成功したレスポンス。

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

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

post
AIへの質問リクエストを送信
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/ai/ask" \
     -H "content-type: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
         "mode": "single_item_qa",
         "prompt": "What is the value provided by public APIs based on this document?",
         "items": [
        {
            "type": "file",
            "id": "9842787262"
        }
       ],
     }'
Java
BoxAIResponse response = BoxAI.sendAIRequest(
    api,
    "What is the content of the file?",
    Collections.singletonList("123456", BoxAIItem.Type.FILE)),
    BoxAI.Mode.SINGLE_ITEM_QA
);

レスポンスの例

{
  "answer": "Public APIs are important because of key and important reasons.",
  "completion_reason": "done",
  "created_at": "2012-12-12T10:53:43-08:00"
}