Skip to content

Commit a11e88a

Browse files
authored
Update video-indexer-output-json.md
1 parent 17ac609 commit a11e88a

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

articles/cognitive-services/video-indexer/video-indexer-output-json.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This article examines the JSON content returned by the **Get Breakdowns** API.
4040

4141
Attribute | Description
4242
---|---
43-
id|The id of this video. For example, 63c6d532ff.
43+
id|The Id of this video. For example, 63c6d532ff.
4444
partition|A logical partition that the user can specify in upload in order to search for it later.
4545
name|The name of the video. For example, Azure Monitor.
4646
description|Description of the video. For example, "John Kemnetz joins Scott Hanselman to show how to unlock the power of Azure monitoring data with Azure Monitor."
@@ -61,7 +61,7 @@ This section shows the summary of the insights.
6161
Attribute | Description
6262
---|---
6363
name|The name of the video. For example, Azure Monitor.
64-
shortId|The id of the video. For example, 63c6d532ff.
64+
shortId|The ID of the video. For example, 63c6d532ff.
6565
privacyMode|Your breakdown can have one of the following modes: **Private**, **Public**. **Public** - the video is visible to everyone in your account and anyone that has a link to the video. **Private** - the video is visible to everyone in your account.
6666
duration|Contains one duration that describes the time an insight occurred. Duration is in seconds.
6767
thumbnailUrl|The video's thumbnail full URL. For example, "https://www.videoindexer.ai/api/Thumbnail/3a9e38d72e/d1f5fac5-e8ae-40d9-a04a-6b2928fb5d10?accessToken=eyJ0eXAiOiJKV1QiLCJhbGciO...". Notice that if the video is private, the URL contains a one hour access token. After one hour, the URL will no longer be valid and you will need to either get the breakdown again with a new url in it, or call GetAccessToken to get a new access token and construct the full url manually ('https://www.videoindexer.ai/api/Thumbnail/[shortId]/[ThumbnailId]?accessToken=[accessToken]').
@@ -88,10 +88,10 @@ This section shows the details of the insights.
8888

8989
Attribute | Description
9090
---|---
91-
id|The breakdown id. For example, 63c6d532ff.
91+
id|The breakdown ID. For example, 63c6d532ff.
9292
state|The processing state of the given breakdown id. Could be one of the following: Uploaded, Processing, Processed, Failed.
9393
processingProgress|The progress. For example, 10%.
94-
externalId| You can set externalId during upload. For example, "4f9c3500-eca7-4ab3-987e-a745017af698". You can later search for your videos by this external id.
94+
externalId| You can set externalId during upload. For example, "4f9c3500-eca7-4ab3-987e-a745017af698". You can later search for your videos by this external ID.
9595
externalUrl|You can set externalUrl during upload.
9696
metadata|You can set metadata during upload.
9797
insights|May contain one or more [insights](#insights)
@@ -120,8 +120,8 @@ audioEffectsCategories|May contain one or more [audioEffectsCategories](#audioEf
120120

121121
Attribute | Description
122122
---|---
123-
id|The id of a person. For example, 11775.
124-
shortId|The short id. Because a playlist may be derived from several breakdowns, this id is needed to find out which of these breakdowns is the origin of each face.
123+
id|The ID of a person. For example, 11775.
124+
shortId|The short ID. Because a playlist may be derived from several breakdowns, this ID is needed to find out which of these breakdowns is the origin of each face.
125125
name|If the face is recognized, the name of the person is added. For example, "Scott Hanselman". If the face is unknown, "Unknown #" is added.
126126
description|If the face is recognized, the description is populated based on the Bing API search. Otherwise, the description is **null**.
127127
title|If the face is recognized, the description is populated based on the Bing API search. Otherwise, the title is **null**.
@@ -136,7 +136,7 @@ seenDurationRatio|Presence relative to the video duration (0-1).
136136

137137
Attribute | Description
138138
---|---
139-
id|The id of a person. For example, 11775.
139+
id|The ID of a person. For example, 11775.
140140
bingId|
141141
name|If the face is recognized, the name of the person is added. For example, "Scott Hanselman". If the face is unknown, "Unknown #" is added.
142142
thumbnailId|For example, 616468f0-1636-4efa-94e7-262f2e575059.
@@ -164,7 +164,7 @@ isTranscript|True, if found in a transcript. False, if found in an OCR.
164164

165165
|Attribute | Description |
166166
|---|---|
167-
|id|Unique topic id.|
167+
|id|Unique topic ID.|
168168
|name|The topic name.|
169169
|stem|Currently, this attribute is not used.|
170170
|words|Currently, this attribute is not used.|
@@ -200,7 +200,7 @@ endSeconds| Time value.
200200

201201
Attribute | Description
202202
---|---
203-
id|The id of the participant.
203+
id|The ID of the participant.
204204
name|The name of the participant. For example, Speaker #1.
205205
pictureUrl|The **pictureUrl** attribute is reserved for future use.
206206

@@ -219,14 +219,14 @@ isAdult|Boolean values indicating if the video is considered an adult video afte
219219

220220
Attribute | Description
221221
---|---
222-
type|Id of the category.
222+
type|ID of the category.
223223
key|One of the following: Speech, Silence, HandClaps.
224224

225225
## transcriptBlocks
226226

227227
Attribute | Description
228228
---|---
229-
id|Id of the block.
229+
id|ID of the block.
230230
lines|May contain one or more [lines](#lines)
231231
sentimentIds|The **sentimentIds** attribute is reserved for future use.
232232
thumbnailIds|The **thumbnailIds** attribute is reserved for future use.
@@ -255,7 +255,7 @@ lines|May contain one or more [lines](#lines).
255255

256256
Attribute | Description
257257
---|---
258-
id| The id of the line.
258+
id| The ID of the line.
259259
timeRange|The time range in the original video.
260260
adjustedTimeRange|AdjustedTimeRange is the time range relative to the current playlist. Since you can create a playlist from different lines of different videos, you can take a 1-hour video and use just 1 line from it, for example, 10:00-10:15. In that case, you will have a playlist with 1 line, where the time range is 10:00-10:15 but the adjustedTimeRange is 00:00-00:15.
261261
participantID| The id of the speaker of this line.
@@ -268,7 +268,7 @@ isIncluded| In base breakdowns always true. In derived playlists, the lines that
268268

269269
Attribute | Description
270270
---|---
271-
id|The OCR id.
271+
id|The OCR ID.
272272
width|Currently, this attribute is not used.
273273
height|Currently, this attribute is not used.
274274
language|The OCR language.
@@ -279,7 +279,7 @@ confidence|The confidence score (higher is better).
279279

280280
Attribute | Description
281281
---|---
282-
id|The scene id.
282+
id|The scene ID.
283283
timeRange|Contains one **timeRange**.
284284
keyFrame|The time of the key frame.
285285
shots|May contain one or more [shots](#shots).
@@ -288,7 +288,7 @@ shots|May contain one or more [shots](#shots).
288288

289289
Attribute | Description
290290
---|---
291-
id||The shot id.
291+
id||The shot ID.
292292
timeRange|Contains one **timeRange**.
293293
keyFrame|The time of the key frame.
294294

@@ -314,7 +314,7 @@ Returns tags based on recognizable objects, living beings, scenery, actions and
314314

315315
|Attribute|Description|
316316
|---|---|
317-
|id|The id of the annotation.|
317+
|id|The ID of the annotation.|
318318
|Name|The name of the annotation (for example, Person, Athletic game, Black Frames).|
319319
|Appearances|May contain one or more appearances.|
320320

@@ -324,7 +324,7 @@ Business and product brand names detected in the speech to text transcript and/o
324324

325325
Attribute | Description
326326
---|---
327-
id | The id of a brand.
327+
id | The ID of a brand.
328328
name | The name of the brand from Bing or a customized brand.
329329
wikiId | The suffix of the brand wikipedia url. For example, "Target_Corporation” is the suffix of [https://en.wikipedia.org/wiki/Target_Corporation](https://en.wikipedia.org/wiki/Target_Corporation).
330330
wikiUrl | The brand’s Wikipedia url, if exists. For example, [https://en.wikipedia.org/wiki/Target_Corporation](https://en.wikipedia.org/wiki/Target_Corporation).

0 commit comments

Comments
 (0)