Box開発者向けドキュメントポータル
ログイン

スキルカード

汎用のBox Skillメタデータカード。

string
skill_card

skill_card

次の値に固定: skill_card

string / date-time
2018-04-13T13:53:23-07:00

このカードの作成日時 (省略可)。

integer
1000

総持続時間 (秒) (省略可)。

skill_card_typeがtranscriptまたはtimelineの場合に使用されます。

object array

メタデータカード内のエントリのリスト (省略可)。

このフィールドは、skill_card_typeがtranscript、keyword、またはtimelineの場合に使用されます。

object array

エントリのタイムスタンプのリストを定義します。これは、項目をタイムラインに配置するためにskill_card_typeがtranscriptやtimelineの場合に使用されます。

skill_card_typeがtranscriptの場合、このリストでは項目ごとに1つのエントリを設定できます。また、タイムラインにトランスクリプトを配置するにはstartの時刻のみが使用されます。

integer
20

エントリがタイムライン上に表示されなくなる時間 (秒)。skill_card_typeがtranscriptの場合、この値は無視されます。

integer
1

エントリがタイムライン上に表示され始める時間 (秒)。

string
https://example.com/image1.jpg

タイムラインに表示されるエントリを示す画像。この画像のURLはすべてのtimelineカードに必要です。この画像は項目 (顔など) のリストに表示されます。また、画像をクリックすると、このエントリの期間中にそのエントリが表示される位置がユーザーに示されます。

string
keyword1

エントリのテキスト。これは、keywordカードにある実際のキーワード、transcriptカードにあるトランスクリプトの行、またはtimelineエントリ使用時の項目の表示名になります。

object

このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。

string
image-recognition-service-123

このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、image-recognition-serviceが複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。

string
skill_invocation

skill_invocation

次の値に固定: skill_invocation

object

このメタデータを適用したサービス。

string
image-recognition-service

このメタデータを適用したサービスを表すカスタム識別子。

string
service

service

次の値に固定: service

object

カードのタイトル。

string
my_transcripts

タイトルの識別子 (省略可)。

string
My Transcripts

UI上で表示する実際のタイトル。

string
status

ファイルに追加するカードのタイプ。

次の値のいずれか1つ: transcript,keyword,timeline,status

object

スキルのステータスを設定するためにstatusタイプのカードで使用されます。これを使用すると、スキルがデータを処理している間、ユーザーにメッセージを表示できます。

string
success

このスキル呼び出しのステータスを表すコード。デフォルトでは、各コードには独自のメッセージが伴います。これらのメッセージを調整するには、このオブジェクトのmessage値を設定します。

次の値のいずれか1つ: invoked,processing,success,transient_failure,permanent_failure

string
We're preparing to process your file. Please hold on!

このステータスで提供できるカスタムメッセージ。ウェブアプリでエンドユーザーに表示されます。

レスポンスの例

{
  "type": "skill_card",
  "created_at": "2018-04-13T13:53:23-07:00",
  "duration": 1000,
  "entries": [
    {
      "text": "keyword1",
      "appears": [
        {
          "start": 1,
          "end": 20
        }
      ],
      "image_url": "https://example.com/image1.jpg"
    }
  ],
  "invocation": {
    "id": "image-recognition-service-123",
    "type": "skill_invocation"
  },
  "skill": {
    "id": "image-recognition-service",
    "type": "service"
  },
  "skill_card_title": {
    "code": "my_transcripts",
    "message": "My Transcripts"
  },
  "skill_card_type": "status",
  "status": {
    "code": "success",
    "message": "We're preparing to process your file. Please hold on!"
  }
}