メインコンテンツへスキップ
POST
/
ai
/
extract_structured
cURL
curl -i -L 'https://api.box.com/2.0/ai/extract_structured' \
     -H 'content-type: application/json' \
     -H 'authorization: Bearer <ACCESS_TOKEN>' \
     -d '{
        "items": [
          {
            "id": "12345678",
            "type": "file",
            "content": "This is file content."
          }
        ],
        "metadata_template": {
            "template_key": "",
            "type": "metadata_template",
            "scope": ""
        },
        "fields": [
            {
              "key": "name",
              "description": "The name of the person.",
              "displayName": "Name",
              "prompt": "The name is the first and last name from the email address.",
              "type": "string",
              "options": [
                {
                  "key": "First Name"
                },
                {
                  "key": "Last Name"
                }
              ]
            }
        ],
        "ai_agent": {
          "type": "ai_agent_extract_structured",
          "long_text": {
            "model": "azure__openai__gpt_4o_mini"
            },
          "basic_text": {
            "model": "azure__openai__gpt_4o_mini"
         }
      }
   }'
{
  "answer": {},
  "created_at": "2012-12-12T10:53:43-08:00",
  "completion_reason": "done",
  "ai_agent_info": {
    "models": [
      {
        "name": "azure__openai__text_embedding_ada_002",
        "provider": "azure",
        "supported_purpose": "embedding"
      }
    ],
    "processor": "basic_text"
  }
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。Box SDKのバージョニング戦略について詳しく学ぶ。」

認証

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/json

AIによる抽出 (構造化) リクエストオブジェクト。

items
AI項目 (Base) · object[]
必須

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

Required array length: 1 - 25 elements
metadata_template
object

抽出するフィールドを含むメタデータテンプレート。リクエストを機能させるには、metadata_templateまたはfieldsを指定する必要がありますが、両方を指定することはできません。

fields
object[]

指定された項目から抽出するフィールド。リクエストを機能させるには、metadata_templateまたはfieldsを指定する必要がありますが、両方を指定することはできません。

Minimum array length: 1
ai_agent
AIによる抽出 (構造化) リクエストのエージェント · object

抽出 (構造化) に使用されるAIエージェント。指定しなかった場合、デフォルトではエージェント (標準) になります。抽出エージェント (強化) を使用する場合の詳細については、抽出エージェント (強化) を参照してください。

レスポンス

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

AIによる抽出 (構造化) のレスポンス。

answer
AIによる抽出のレスポンス · object
必須

AIによる抽出のレスポンス。このレスポンスのコンテンツは、リクエストされた構成に応じて異なる場合があります。

created_at
string<date-time>
必須

プロンプトに対する回答が作成された時点のISO日付形式のタイムスタンプ。

:

"2012-12-12T10:53:43-08:00"

completion_reason
string

応答が終了した理由。

:

"done"

ai_agent_info
リクエストで使用されるモデルおよびプロセッサに関する情報。 · object

リクエストで使用されるモデルおよびプロセッサに関する情報。