メタデータを抽出 (構造化)
サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、抽出されたメタデータを一連のキー/値ペアとして返します。このリクエストでは、すでに定義済みのメタデータテンプレートを使用するか、自分でスキーマを定義する必要があります。テンプレートの作成の詳細については、メタデータテンプレートのカスタマイズを参照するか、メタデータテンプレートAPIを使用してください。
リクエスト
リクエスト本文
抽出 (構造化) に使用されるAIエージェント。
指定された項目から抽出するフィールド。リクエストを機能させるには、metadata_templateまたはfieldsを指定する必要がありますが、両方を指定することはできません。
"enum"フィールドのタイプ。これには、文字列、浮動小数点、日付、列挙型、multiSelectが含まれますが、これらに限定されるものではありません。
"The name of the person."フィールドの説明。
"Name"フィールドの表示名。
"name"フィールドの一意の識別子。
[{"key":"First Name"},{"key":"Last Name"}]このフィールドのオプションのリスト。これは、ほとんどの場合、列挙型およびmultiSelectフィールドタイプと組み合わせて使用します。
"First Name"フィールドの一意の識別子。
"Name is the first and last name from the email address"キーに関するコンテキスト。キーの確認方法や形式が含まれている場合があります。
LLMで処理する項目。現在使用できるのはファイルのみです。
"123"ファイルのID。
"file"項目の種類。現在、この値に指定できるのはfileのみです。
次の値に固定: file
"This is file content."項目のコンテンツ (多くの場合はテキストレプリゼンテーション)。
抽出するフィールドを含むメタデータテンプレート。リクエストを機能させるには、metadata_templateまたはfieldsを指定する必要がありますが、両方を指定することはできません。
"metadata_template"値は常にmetadata_template。
次の値に固定: metadata_template
"enterprise_12345"40メタデータテンプレートのスコープ。globalまたはenterpriseを指定できます。
- globalスコープは、任意のBox Enterpriseで利用できるテンプレートに使用されます。
- enterpriseスコープは、特定のEnterprise内で作成されたテンプレートを表し、そのEnterpriseのIDが含まれます。
"invoiceTemplate"メタデータテンプレートの名前。
レスポンス
LLMからの回答を含む成功したレスポンス。
予期しないクライアントエラー。
予期しないサーバーエラー。
予期しないエラー。
リクエストの例
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",
"long_text": {
"model": "azure__openai__gpt_4o_mini"
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini"
}
}
}'await client.ai.createAiExtractStructured({
metadataTemplate: {
templateKey: templateKey,
scope: 'enterprise',
} satisfies AiExtractStructuredMetadataTemplateField,
items: [new AiItemBase({ id: file.id })],
} satisfies AiExtractStructured);client.ai.create_ai_extract_structured(
[AiItemBase(id=file.id)],
metadata_template=CreateAiExtractStructuredMetadataTemplate(
template_key=template_key, scope="enterprise"
),
)await client.Ai.CreateAiExtractStructuredAsync(requestBody: new AiExtractStructured(items: Array.AsReadOnly(new [] {new AiItemBase(id: file.Id)})) { MetadataTemplate = new AiExtractStructuredMetadataTemplateField() { TemplateKey = templateKey, Scope = "enterprise" } });BoxAIExtractMetadataTemplate template = new BoxAIExtractMetadataTemplate("templateKey", "enterprise");
BoxAIExtractStructuredResponse result = BoxAI.extractMetadataStructured(
api,
Collections.singletonList(new BoxAIItem("123456", BoxAIItem.Type.FILE)),
template
);
JsonObject sourceJson = result.getSourceJson();