Beta

メタデータを抽出 (自由形式)

post

https://api.box.com/2.0

/ai/extract

サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、メタデータをキー/値ペアの形式で抽出します。自由形式のメタデータの抽出では、リクエストを送信する前にメタデータテンプレートの設定は必要ありません。

関連するガイド

Box AI AIモデルの上書き

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

リクエスト本文

ai_agent抽出リクエスト用のAIエージェント object本文内

抽出に使用されるAIエージェント。

items object array本文内必須

LLMで処理される項目。現在使用できるのはファイルのみです。

[items].id string本文内必須

例"123"

ファイルのID。

[items].type string本文内必須

例"file"

項目の種類。現在、この値に指定できるのはfileのみです。

次の値に固定: file

[items].content string本文内省略可能

例"This is file content."

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

prompt string本文内必須

例

"\"fields\":[{\"type\":\"string\",\"key\":\"name\",\"displayName\":\"Name\",\"description\":\"The customer name\",\"prompt\":\"Name is always the first word in the document\"},{\"type\":\"date\",\"key\":\"last_contacted_at\",\"displayName\":\"Last Contacted At\",\"description\":\"When this customer was last contacted at\"}]"

リクエストで大規模言語モデル (LLM) に提供されるプロンプト。プロンプトには、最大10,000文字を指定できるほか、XMLまたはJSONスキーマを使用することができます。

レスポンス

200application/jsonAIの応答

LLMからの回答を含むレスポンス。

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

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

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

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

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

予期しないエラー。

post

メタデータを抽出 (自由形式)

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -i -L 'https://api.box.com/2.0/ai/extract' \
     -H 'content-type: application/json' \
     -H 'authorization: Bearer <ACCESS_TOKEN>' \
     -d '{
        "prompt": "Extract data related to contract conditions",
        "items": [
              {
                  "type": "file",
                  "id": "1497741268097"
              }
        ],
        "ai_agent": {
          "type": "ai_agent_extract",
          "long_text": {
            "model": "azure__openai__gpt_4o_mini",
            "prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. What should I see?",
          },
          "basic_text": {
            "model": "azure__openai__gpt_4o_mini",
          }
        }
      }'

TypeScript Gen

await client.ai.createAiExtract({
  prompt: 'firstName, lastName, location, yearOfBirth, company',
  items: [new AiItemBase({ id: file.id })],
} satisfies AiExtract);

Python Gen

client.ai.create_ai_extract(
    "firstName, lastName, location, yearOfBirth, company",
    [AiItemBase(id=file.id)],
    ai_agent=ai_extract_agent_config,
)

.NET Gen

await client.Ai.CreateAiExtractAsync(requestBody: new AiExtract(prompt: "firstName, lastName, location, yearOfBirth, company", items: Array.AsReadOnly(new [] {new AiItemBase(id: file.Id)})));

Java

BoxAIResponse response = BoxAI.extractMetadataFreeform(
    api,
    "firstName, lastName, location, yearOfBirth, company",
    Collections.singletonList(new BoxAIItem("123456", BoxAIItem.Type.FILE))
);

レスポンスの例

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