ステータススキルカード
メタデータサイドバーにステータスメッセージを配置するBox Skillメタデータカード。
string
skill_cardskill_card
次の値に固定: skill_card
string (date-time)
2018-04-13T13:53:23-07:00このカードの作成日時 (省略可)。
object
このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。
string
image-recognition-service-123このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、image-recognition-serviceが複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。
string
skill_invocationskill_invocation
次の値に固定: skill_invocation
object
このメタデータを適用したサービス。
string
image-recognition-serviceこのメタデータを 適用したサービスを表すカスタム識別子。
string
serviceservice
次の値に固定: service
object
カードのタイトル。
string
statusタイトルの識別子 (省略可)。
string
StatusUI上で表示する実際のタイトル。
string
statusstatus
次の値に固定: status
object
スキルのステータスを設定します。これは、スキルがデータを処理している間またはファイルを処理できなかった場合にユーザーにメッセージを表示するのに使用できます。
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",
"invocation": {
"id": "image-recognition-service-123",
"type": "skill_invocation"
},
"skill": {
"id": "image-recognition-service",
"type": "service"
},
"skill_card_title": {
"code": "status",
"message": "Status"
},
"skill_card_type": "status",
"status": {
"code": "success",
"message": "We're preparing to process your file. Please hold on!"
}
}