Skills リソース - Box Dev Docs

Box Skillsは、ファイルの基盤となるメタデータを強化することを目的として、Boxにアップロードされたファイルにカスタム処理を実行するための機能です。

Skillsメタデータインスタンス

Boxスキルの使用に割り当てられたメタデータ。

属性と例

プロパティ	型	必須	説明
`$canEdit`	`boolean`	いいえ	このメタデータをユーザーが編集できるかどうか。
`$id`	`string`	いいえ	メタデータオブジェクトを識別するためのUUID。
`$parent`	`string`	いいえ	親フォルダのID。
`$scope`	`string`	いいえ	このテンプレートが適用されているスコープのID。
`$template`	`string`	いいえ	テンプレートの名前。
`$type`	`string`	いいえ	このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。
`$typeVersion`	`integer`	いいえ	オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。
`$version`	`integer`	いいえ	メタデータオブジェクトのバージョン。0から始まり、ユーザー定義プロパティが変更されるたびに増加します。
`cards`	array of `Box Skillカード`	いいえ	このファイルに適用されているBox Skillカードのリスト。

例

{
  "$canEdit": true,
  "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "properties",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2,
  "$version": 1,
  "cards": [
    {
      "created_at": "2018-04-13T13:53:23-07:00",
      "type": "skill_card",
      "skill_card_type": "keyword",
      "skill_card_title": {
        "code": "labels",
        "message": "Labels"
      },
      "skill": {
        "type": "service",
        "id": "image-recognition-service"
      },
      "invocation": {
        "type": "skill_invocation",
        "id": "image-recognition-service-123"
      },
      "entries": [
        {
          "text": "keyword1"
        }
      ]
    }
  ]
}

キーワードスキルカード

一連のキーワードを含むスキルカード。

属性と例

プロパティ	型	必須	説明
`created_at`	`string`	いいえ	このカードの作成日時 (省略可)。
`type`	`enum<string>`	はい	値は常に`skill_card`になります。使用可能なオプション: `skill_card`.
`skill_card_type`	`enum<string>`	はい	値は常に`keyword`になります。使用可能なオプション: `keyword`.
`skill_card_title`	`object`	いいえ	カードのタイトル。
`skill`	`object`	はい	このメタデータを適用したサービス。
`invocation`	`object`	はい	このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
`entries`	array of `object`	はい	メタデータカード内のエントリのリスト。

例

{
  "created_at": "2018-04-13T13:53:23-07:00",
  "type": "skill_card",
  "skill_card_type": "keyword",
  "skill_card_title": {
    "code": "labels",
    "message": "Labels"
  },
  "skill": {
    "type": "service",
    "id": "image-recognition-service"
  },
  "invocation": {
    "type": "skill_invocation",
    "id": "image-recognition-service-123"
  },
  "entries": [
    {
      "text": "keyword1"
    }
  ]
}

ステータススキルカード

メタデータサイドバーにステータスメッセージを配置するBox Skillメタデータカード。

属性と例

プロパティ	型	必須	説明
`created_at`	`string`	いいえ	このカードの作成日時 (省略可)。
`type`	`enum<string>`	はい	値は常に`skill_card`になります。使用可能なオプション: `skill_card`.
`skill_card_type`	`enum<string>`	はい	値は常に`status`になります。使用可能なオプション: `status`.
`skill_card_title`	`object`	いいえ	カードのタイトル。
`status`	`object`	はい	スキルのステータスを設定します。これは、スキルがデータを処理している間またはファイルを処理できなかった場合にユーザーにメッセージを表示するのに使用できます。
`skill`	`object`	はい	このメタデータを適用したサービス。
`invocation`	`object`	はい	このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。

例

{
  "created_at": "2018-04-13T13:53:23-07:00",
  "type": "skill_card",
  "skill_card_type": "status",
  "skill_card_title": {
    "code": "status",
    "message": "Status"
  },
  "status": {
    "code": "success",
    "message": "We're preparing to process your file. Please hold on!"
  },
  "skill": {
    "type": "service",
    "id": "image-recognition-service"
  },
  "invocation": {
    "type": "skill_invocation",
    "id": "image-recognition-service-123"
  }
}

タイムラインスキルカード

タイムラインに画像のリストを配置するBox Skillメタデータカード。

属性と例

プロパティ	型	必須	説明
`created_at`	`string`	いいえ	このカードの作成日時 (省略可)。
`type`	`enum<string>`	はい	値は常に`skill_card`になります。使用可能なオプション: `skill_card`.
`skill_card_type`	`enum<string>`	はい	値は常に`timeline`になります。使用可能なオプション: `timeline`.
`skill_card_title`	`object`	いいえ	カードのタイトル。
`skill`	`object`	はい	このメタデータを適用したサービス。
`invocation`	`object`	はい	このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
`duration`	`integer`	いいえ	タイムラインの総持続時間 (秒)。
`entries`	array of `object`	はい	タイムライン上のエントリのリスト。

例

{
  "created_at": "2018-04-13T13:53:23-07:00",
  "type": "skill_card",
  "skill_card_type": "timeline",
  "skill_card_title": {
    "code": "Faces",
    "message": "Faces"
  },
  "skill": {
    "type": "service",
    "id": "image-recognition-service"
  },
  "invocation": {
    "type": "skill_invocation",
    "id": "image-recognition-service-123"
  },
  "duration": 1000,
  "entries": [
    {
      "text": "John",
      "appears": [
        {
          "start": 1,
          "end": 20
        }
      ],
      "image_url": "https://example.com/image1.jpg"
    }
  ]
}

トランスクリプトスキルカード

ファイルにトランスクリプトを追加するBox Skillメタデータカード。

属性と例

プロパティ	型	必須	説明
`created_at`	`string`	いいえ	このカードの作成日時 (省略可)。
`type`	`enum<string>`	はい	値は常に`skill_card`になります。使用可能なオプション: `skill_card`.
`skill_card_type`	`enum<string>`	はい	値は常に`transcript`になります。使用可能なオプション: `transcript`.
`skill_card_title`	`object`	いいえ	カードのタイトル。
`skill`	`object`	はい	このメタデータを適用したサービス。
`invocation`	`object`	はい	このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
`duration`	`integer`	いいえ	総持続時間 (秒) (省略可)。 `skill_card_type`が`transcript`または`timeline`の場合に使用されます。
`entries`	array of `object`	はい	カードのエントリのリスト。これは、書き起こしの個々のエントリを表します。

例

{
  "created_at": "2018-04-13T13:53:23-07:00",
  "type": "skill_card",
  "skill_card_type": "transcript",
  "skill_card_title": {
    "code": "my_transcripts",
    "message": "My Transcripts"
  },
  "skill": {
    "type": "service",
    "id": "transciption-service"
  },
  "invocation": {
    "type": "skill_invocation",
    "id": "transciption-service-123"
  },
  "duration": 1000,
  "entries": [
    {
      "text": "Hi, and welcome to this video...",
      "appears": [
        {
          "start": 1
        }
      ]
    }
  ]
}

​Skillsメタデータインスタンス

​キーワードスキルカード

​ステータススキルカード

​タイムラインスキルカード

​トランスクリプトスキルカード

Skillsメタデータインスタンス

キーワードスキルカード

ステータススキルカード

タイムラインスキルカード

トランスクリプトスキルカード