A generic Box Skill metadata card.
skill_card
skill_card
Value is always skill_card
2018-04-13T13:53:23-07:00
The optional date and time this card was created at.
1000
An optional total duration in seconds.
Used with a skill_card_type
of transcript
or
timeline
.
An optional list of entries in the metadata card.
This field is used with a skill_card_type
of
transcript
, keyword
or timeline
.
Defines a list of timestamps for an entry. This is
used with a skill_card_type
of transcript
as
well as timeline
to place items on a timeline.
For a skill_card_type
of transcript
there can
only be one entry in this list for each item, and
only the start
time is used to place the
transcript on the timeline.
20
The time in seconds when an
entry should stop appearing on a timeline. For
a skill_card_type
of transcript
this value
is ignored.
1
The time in seconds when an entry should start appearing on a timeline.
https://example.com/image1.jpg
The image to show on a for an entry that appears
on a timeline. This image URL is required for any
timeline
cards. The image will be shown in a
list of items (for example faces), and clicking
the image will show the user where that entry
appears during the duration of this entry.
keyword1
The text of the entry. This would be the actual
keyword in a keyword
card, the line of a
transcript in a transcript
card, or the display
name for an item when using the timeline
entry.
The invocation of this service, used to track which instance of a service applied the metadata.
image-recognition-service-123
A custom identifier that represent the instance of
the service that applied this metadata. For example,
if your image-recognition-service
runs on multiple
nodes, this field can be used to identify the ID of
the node that was used to apply the metadata.
skill_invocation
skill_invocation
Value is always skill_invocation
The service that applied this metadata.
image-recognition-service
A custom identifier that represent the service that applied this metadata.
service
service
Value is always service
The title of the card.
my_transcripts
An optional identifier for the title.
My Transcripts
The actual title to show in the UI.
status
The type of card to add to the file.
Value is one of transcript
,keyword
,timeline
,status
Used with a card of type status
to set the status of the skill. This can be used to show a message to the user while the Skill is processing the data.
success
A code for the status of this Skill invocation. By
default each of these will have their own accompanied
messages. These can be adjusted by setting the message
value on this object.
Value is one of invoked
,processing
,success
,transient_failure
,permanent_failure
We're preparing to process your file. Please hold on!
A custom message that can be provided with this status. This will be shown in the web app to the end user.
{
"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!"
}
}