スキル呼び出しを更新

put
https://api.box.com/2.0
/skill_invocations/:skill_invocation_id/

スキル呼び出しのステータス、利用状況、応答のメタデータを更新します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
33243242

スキル呼び出しのID。

リクエスト本文

object本文内

このメタデータを割り当てるファイル

stringnull省略可能
3243244

ファイルのID

stringnull省略可能
file

次の値に固定: file

object本文内

このメタデータを割り当てるファイルバージョン

stringnull省略可能
3

ファイルバージョンのID

stringnull省略可能
file_version

次の値に固定: file_version

object本文内

このスキルに対して設定するメタデータ

object arraynull省略可能

ファイルに設定するメタデータカード。

stringnull条件付きで必須
skill_card

次の値に固定: skill_card

string / date-timenull条件付きで必須
2012-12-12T10:53:43-08:00

カードが作成された日時

integernull省略可能
1000

期間(省略可)。

transcriptcard_type、またはtimelineで使用します。

object arraynull省略可能

エントリのリスト(省略可)。

transcriptcard_typekeyword、またはtimelineで使用します。

stringnull条件付きで必須
text

次の値に固定: text

stringnull条件付きで必須
keyword1

エントリのテキスト

現在のスキル呼び出し

stringnull省略可能
33243242

スキル呼び出しのID。

stringnull省略可能
skill_invocation

次の値に固定: skill_invocation

objectnull

カードを更新しているスキル

stringnull省略可能
43342423234

スキルのID。

stringnull省略可能
service

次の値に固定: service

カードのタイトル

stringnull省略可能
my_transcripts

役職の識別子

stringnull省略可能
My Transcripts

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

stringnull省略可能
status

作成するカードのタイプ

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

objectnull

ステータス(省略可)。statuscard_typeで使用します。

stringnull省略可能
skills_pending_status

設定するステータスのタイプ

次の値のいずれか1つ: skills_pending_status,custom_error

stringnull省略可能
We're preparing to process your file. Please hold on!

UI上で表示するステータスについてのメッセージ。

string本文内必須
success

スキル呼び出しのステータスを設定します。

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

レスポンス

none

空の応答を返します。

予期しないクライアントエラー。

put
スキル呼び出しを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -X PUT https://api.box.com/2.0/skill_invocations/33243242 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>' \
     -H 'Content-Type: application/json' \
     -d '{
       "status": "success",
       "metadata": {
         "cards": [{
            "type": "skill_card",
            "skill_card_type": "keyword",
            "skill_card_title": {
              "code": "license-plates",
              "message": "Licence Plates"
            },
            "skill": {
              "type": "service"
              "id": "license-plates-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "license-plates-service-123"
            },
            "entries": {
              { "text": "DD-26-YT" },
              { "text": "DN86 BOX" }
            }
          },{
            "type": "skill_card",
            "skill_card_type": "transcript",
            "skill_card_title": {
              "code": "video-transcription",
              "message": "Video Transcription"
            },
            "skill": {
              "type": "service"
              "id": "video-transcription-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "video-transcription-service-123"
            },
            "duration": 1000,
            "entries": {
              { 
                "text": "Hi John, have I told you about Box recently?", 
                "appears": [{ "start": 0 }] 
              },
              { 
                "text": "No Aaron, you have not. Tell me more!", 
                "appears": [{ "start": 5 }] 
              }
            }
          },{
            "type": "skill_card",
            "skill_card_type": "timeline",
            "skill_card_title": {
              "code": "face-detection",
              "message": "Faces"
            },
            "skill": {
              "type": "service"
              "id": "face-detection-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "face-detection-service-123"
            },
            "duration": 1000,
            "entries": {
              { 
                "text": "John", 
                "appears": [{ "start": 0, "end": 5 }, { "start": 10, "end": 15 }], 
                "image_url": "https://example.com/john.png" 
              },
              { 
                "text": "Aaron", 
                "appears": [{ "start": 5, "end": 10 }], 
                "image_url": "https://example.com/aaron.png" 
              }
            }
          },{
            "type": "skill_card",
            "skill_card_type": "status",
            "skill_card_title": {
              "code": "hold",
              "message": "Please hold..."
            },
            "skill": {
              "type": "service"
              "id": "face-detection-service"
            },
            "invocation": {
              "type": "skill_invocation"
              "id": "face-detection-service-123"
            },
            "status": {
              "code": "processing",
              "message": "We are processing this file right now."
            }
          }],
       },
       "file": {
         "id": "12345"
       },
       "usage": {
         "unit": "file",
         "value": 1
       }
     }'