> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
> Box AIを使用してドキュメントから自動的に構造化データを抽出し、Box Python SDKを使用して検索可能なメタデータとして保存する方法についてご紹介します。
# PythonでのBox AIを使用した構造化データの抽出
export const SignupCTA = ({children}) => {
return ;
};
export const Link = ({href, children, className, ...props}) => {
const localizedHref = localizeLink(href);
return
{children}
;
};
無料のDeveloperアカウントを作成すると、Box AI APIにアクセスできます。APIを使用して、ドキュメントの要約、質問への回答、メタデータ抽出を試してみましょう。
任意のBox Platform統合では、最初のステップとして、Boxアプリケーションを作成して構成します。
1.
この手順では、管理者がBox Enterpriseにアクセスできる必要があります。現在の環境でアクセス権限がない場合は、Box管理者に連絡してください。
Box AIを使用すると、いくつかの方法でドキュメントからデータを抽出できます。
| 型 | 説明 | ユースケース |
| ------------------- | ------------------------ | ---------------------------------------------------- |
| 抽出 (自由形式) | 文字列のプロンプトを使用できます。 | 自然言語のプロンプトを入力します。 |
| テンプレートを使用した抽出 (構造化) | Boxメタデータテンプレートキーを使用できます。 | フィールドとデータ型を1回定義します。そうすると、メタデータとしてBoxに戻す処理がシンプルになります。 |
| フィールドを使用した抽出 (構造化) | フィールドのJSON配列を使用できます。 | テンプレートを作成せず、1回限りの抽出を実行します。 |
| 抽出エージェント (強化) | 推論モデルを備えた専任エージェントを使用します。 | 複雑なドキュメントや、複雑かつ繊細な抽出に適しており、構造化されたテンプレートやフィールドで動作します。 |
このクイックスタートでは、ドキュメントから抽出するフィールドを定義するためのBoxメタデータテンプレートを作成します。Box管理コンソールでBoxメタデータテンプレートを作成する手順の詳細な説明については、
フィールドの説明は、正しいデータが抽出されるように、LLMへのプロンプトの補完情報としてBox AIによって使用されます。
3. \[**保存**] をクリックしてテンプレートを作成します。テンプレートキーは後で使用できるようにメモしておきます。
テンプレートを保存すると、テンプレートのリストが表示されます。テンプレートキーを確認するには、先ほど作成したテンプレートを開き、URLを調べます。パスの最後の部分がテンプレートキーです。たとえば、次のようなURLがあるとします: `https://app.box.com/master/metadata/templates/boxAiExtractquick start`
この場合、テンプレートキーは`boxAiExtractquick start`です。
テンプレートを準備できたら、テストするファイルを選択します。このクイックスタートでは、こちらの
抽出を実行するために、開発環境を設定します。このクイックスタートでは、PythonとBox Python SDKバージョン10を使用します。お使いのマシンにPython 3.11以上がインストールされていることを確認してください。
1. プロジェクト用に新しいディレクトリを作成し、そのディレクトリに移動します。
2. 仮想環境を作成します。
```bash theme={null}
python3 -m venv .venv
source .venv/bin/activate
```
3. Box Python SDKをインストールします。
```bash theme={null}
pip install "boxsdk~=10"
```
4. `.env`ファイルから環境変数を読み込むために`python-dotenv`パッケージをインストールします。
```bash theme={null}
pip install python-dotenv
```
5. プロジェクトディレクトリのルートに`.env`ファイルを作成し、以下の環境変数を追加します。その際、プレースホルダの値を実際のBoxアプリの資格情報と前の手順で確認したIDに置き換えます。
```bash theme={null}
BOX_DEVELOPER_TOKEN=your_box_developer_token
BOX_METADATA_TEMPLATE_KEY=your_metadata_template_key
BOX_FILE_ID=your_box_file_id
```
開発者トークンを取得するには、Box開発者コンソールに移動します。アプリを開き、\[**構成**] タブに移動します。
6. \[**開発者トークンを生成**] をクリックして新しいトークンを作成します。
簡略化するために、このクイックスタートでは、有効期間の短い開発者トークンを使用します。実稼働環境では、開発者トークンではなく、お使いのアプリに設定された方法 (クライアント資格情報許可など) で認証する必要があります。
開発環境の準備ができました。Box AIを使用してドキュメントからデータを抽出するPythonスクリプトを作成できます。
1. プロジェクトディレクトリのルートに`extract.py`という名前の新しいファイルを作成し、以下のコードを追加します。
```python theme={null}
import os
from dotenv import load_dotenv
from box_sdk_gen import (
AiItemBase,
BoxClient,
BoxDeveloperTokenAuth,
CreateAiExtractStructuredMetadataTemplate,
CreateAiExtractStructuredMetadataTemplateTypeField,
CreateFileMetadataByIdScope
)
load_dotenv()
developer_token = os.getenv("BOX_DEVELOPER_TOKEN")
file_id = os.getenv("BOX_FILE_ID")
template_key = os.getenv("BOX_METADATA_TEMPLATE_KEY")
def get_box_client(token: str) -> BoxClient:
if not developer_token:
raise ValueError("BOX_DEVELOPER_TOKEN is not set in environment variables.")
auth = BoxDeveloperTokenAuth(token=token)
client = BoxClient(auth=auth)
return client
def main():
client = get_box_client(token=developer_token)
me = client.users.get_user_me()
print(f"My user ID is {me.id}")
if __name__ == "__main__":
main()
```
このコードは、環境変数を`.env`ファイルから読み込み、Box SDKクライアントを初期化し、現在のユーザーのIDを出力して、クライアントが正しく動作していることを確認します。
2. ターミナルで次のコマンドを使用してスクリプトを実行します。
```bash theme={null}
python extract.py
```
Box SDKクライアントが正しく設定されると、コンソールにはユーザーIDが表示されます。次に例を示します。
```bash theme={null}
My user ID is 123456789
```
Box SDKクライアントが動作を開始したら、Box AIを使用してドキュメントからデータを抽出するためのコードを追加できます。
1. `get_box_client`関数と`main`関数の間に次の関数を追加します。
```python theme={null}
def extract_metadata(client: BoxClient, file_id: str, template_key: str) -> dict:
metadata = client.ai.create_ai_extract_structured(
[AiItemBase(id=file_id)],
metadata_template=CreateAiExtractStructuredMetadataTemplate(
template_key=template_key,
type=CreateAiExtractStructuredMetadataTemplateTypeField.METADATA_TEMPLATE,
scope="enterprise",
),
)
return metadata.to_dict()['answer']
```
この関数はBox AIの`create_ai_extract_structured`メソッドを使用して、指定されたファイルからメタデータを抽出します。BoxClient、ファイルID、前の手順で作成したメタデータテンプレートキーが関数に送信され、抽出されたメタデータがディクショナリとして返されます。
2. `main`関数でメタデータを抽出する関数呼び出しを追加します。新しい`main`関数に次のロジックが含まれていることを確認します。
```python theme={null}
def main():
client = get_box_client(token=developer_token)
me = client.users.get_user_me()
print(f"My user ID is {me.id}")
metadata = extract_metadata(client=client, file_id=file_id, template_key=template_key)
print(f"Extracted Metadata: {metadata}")
```
SDKはBox AIへのAPIコールを処理し、抽出されたメタデータを
ドキュメントからメタデータを抽出できました。これで、データベースへのプッシュ、CRMとの統合、エージェントへの処理用フィード、自動化ワークフローの開始などの目的で、キー/値ペアを自分のアプリケーションで使用できるようになります。
このクイックスタートでは、抽出されたデータをファイルのメタデータとしてBoxに戻す方法を説明します。Boxのメタデータ管理機能では、強力なフィルタ機能と検索機能をコンテンツ全体で使用できます。たとえば、過去30日間の500ドルを超える請求書を全件照会したり、Box Appsでダッシュボードを作成したり、ドキュメントの主なインサイトをBoxウェブアプリに直接表示したりできます。
1. 次の関数を`extract_metadata`関数と`main`関数の間に追加して、抽出されたメタデータをBoxに戻します。
```python theme={null}
def push_metadata(client: BoxClient, file_id: str, metadata: dict, template_key: str) -> dict:
attached_metadata = client.file_metadata.create_file_metadata_by_id(
file_id,
CreateFileMetadataByIdScope.ENTERPRISE,
template_key,
metadata,
)
return attached_metadata.to_dict()
```
この関数では`create_file_metadata_by_id`メソッドを使用して、指定されたファイルにメタデータを追加し、BoxClient、ファイルID、メタデータディクショナリ、テンプレートキーを処理します。API自体は
## リソース
*