Box Developerドキュメント

Box AIの使い方

Box AIの使い方

Endpoints related to metadata extraction are currently a beta feature offered subject to Box’s Main Beta Agreement, and the available capabilities may change. Box AI API is available to all Enterprise Plus and Enterprise Advanced customers.

ソリューションにBox AI APIを実装するには、その機能にアクセスできることを確認する必要があります。また、Box AIスコープが有効になっているカスタムアプリケーションと、コールを認証するための開発者トークンも必要です。

Box AI APIを使用するには、管理者が管理コンソールでこのAPIを有効にしていることを確認してください。サンドボックスでBox AI APIを使用したい場合は、こちらのフォームを使用してBox AIチームにアクセス権限をリクエストしてください。

Create a custom application

まず、コールの実行に使用するカスタムアプリケーションを作成する必要があります。アプリケーションを作成するには、カスタムアプリの作成に関するガイドに従ってください。

Box AI APIへのアクセスの有効化

Box AI APIを操作するには、アプリケーションにai.readwriteスコープを追加する必要があります。このスコープを追加する前に、Box管理者からBox AI APIへのアクセス権限が付与されていることを確認してください。アプリの構成設定で [AIを管理する] オプションが表示されていない場合は、管理者までお問い合わせください。

スコープを追加するには、以下の手順を実行します。

  1. 開発者コンソールで、目的のアプリケーションを開きます。

  2. [構成] > [必須のアクセススコープ] > [コンテンツ操作] に移動します。

  3. [AIを管理する] スコープを選択します。Box Platformでは、コールを実行すると自動的にこのスコープが含まれます。あるアプリのコラボレータとして追加されているのにBox AI APIにアクセスできない場合は、[AIを管理する] スコープのチェックボックスがオンになった状態で、グレー表示になっています。つまり、アプリの所有者のAIのスコープは有効になっていますが、この設定を変更することはできません。

    Box AIのスコープ

  4. 承認または有効化のためにアプリを送信します。既存のアプリケーションに対してBox AI APIを有効にする場合は、アプリケーションを再承認する必要があります。

開発者トークンの生成

リクエストの送信時にアプリを認証するには、開発者トークンが必要です。

トークンを生成するには、以下の手順を実行します。

  1. [開発者コンソール] > [マイPlatformアプリ] に移動します。
  2. 右側のオプションメニューボタン ([…]) をクリックします。
  3. [開発者トークンを生成] を選択します。トークンが自動的に生成され、クリップボードに保存されます。

トークンの生成

アプリを開いて、[構成] > [開発者トークン] に移動してトークンを生成することもできます。

開発者トークンの有効期限は1時間のみです。

詳細については、開発者トークンを参照してください。トークンを生成したら、cURLや他のクライアント (Postmanなど) で使用してコールを実行できます。