Index
VideoIntelligenceService
(interface)AnnotateVideoProgress
(message)AnnotateVideoRequest
(message)AnnotateVideoResponse
(message)Entity
(message)ExplicitContentAnnotation
(message)ExplicitContentDetectionConfig
(message)ExplicitContentFrame
(message)Feature
(enum)LabelAnnotation
(message)LabelDetectionConfig
(message)LabelDetectionMode
(enum)LabelFrame
(message)LabelSegment
(message)Likelihood
(enum)NormalizedBoundingBox
(message)NormalizedBoundingPoly
(message)NormalizedVertex
(message)ObjectTrackingAnnotation
(message)ObjectTrackingFrame
(message)ShotChangeDetectionConfig
(message)SpeechContext
(message)SpeechRecognitionAlternative
(message)SpeechTranscription
(message)SpeechTranscriptionConfig
(message)TextAnnotation
(message)TextDetectionConfig
(message)TextFrame
(message)TextSegment
(message)VideoAnnotationProgress
(message)VideoAnnotationResults
(message)VideoContext
(message)VideoSegment
(message)WordInfo
(message)
VideoIntelligenceService
Service that implements Google Cloud Video Intelligence API.
AnnotateVideo | |
---|---|
Performs asynchronous video annotation. Progress and results can be retrieved through the
|
AnnotateVideoProgress
Video annotation progress. Included in the metadata
field of the Operation
returned by the GetOperation
call of the google::longrunning::Operations
service.
Fields | |
---|---|
annotation_progress[] |
Progress metadata for all videos specified in |
AnnotateVideoRequest
Video annotation request.
Fields | |
---|---|
input_uri |
Input video location. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: |
input_content |
The video data bytes. If unset, the input video(s) should be specified via |
features[] |
Requested video annotation features. |
video_context |
Additional video context and/or feature-specific parameters. |
output_uri |
Optional location where the output (in JSON format) should be stored. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: |
location_id |
Optional cloud region where annotation should take place. Supported cloud regions: |
AnnotateVideoResponse
Video annotation response. Included in the response
field of the Operation
returned by the GetOperation
call of the google::longrunning::Operations
service.
Fields | |
---|---|
annotation_results[] |
Annotation results for all videos specified in |
Entity
Detected entity from video analysis.
Fields | |
---|---|
entity_id |
Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API. |
description |
Textual description, e.g. |
language_code |
Language code for |
ExplicitContentAnnotation
Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame.
Fields | |
---|---|
frames[] |
All video frames where explicit content was detected. |
ExplicitContentDetectionConfig
Config for EXPLICIT_CONTENT_DETECTION.
Fields | |
---|---|
model |
Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". |
ExplicitContentFrame
Video frame level annotation results for explicit content.
Fields | |
---|---|
time_offset |
Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. |
pornography_likelihood |
Likelihood of the pornography content.. |
Feature
Video annotation feature.
Enums | |
---|---|
FEATURE_UNSPECIFIED |
Unspecified. |
LABEL_DETECTION |
Label detection. Detect objects, such as dog or flower. |
SHOT_CHANGE_DETECTION |
Shot change detection. |
EXPLICIT_CONTENT_DETECTION |
Explicit content detection. |
SPEECH_TRANSCRIPTION |
Speech transcription. |
TEXT_DETECTION |
OCR text detection and tracking. |
OBJECT_TRACKING |
Object detection and tracking. |
LabelAnnotation
Label annotation.
Fields | |
---|---|
entity |
Detected entity. |
category_entities[] |
Common categories for the detected entity. E.g. when the label is |
segments[] |
All video segments where a label was detected. |
frames[] |
All video frames where a label was detected. |
LabelDetectionConfig
Config for LABEL_DETECTION.
Fields | |
---|---|
label_detection_mode |
What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to |
stationary_camera |
Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with |
model |
Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". |
frame_confidence_threshold |
The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. |
video_confidence_threshold |
The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. |
LabelDetectionMode
Label detection mode.
Enums | |
---|---|
LABEL_DETECTION_MODE_UNSPECIFIED |
Unspecified. |
SHOT_MODE |
Detect shot-level labels. |
FRAME_MODE |
Detect frame-level labels. |
SHOT_AND_FRAME_MODE |
Detect both shot-level and frame-level labels. |
LabelFrame
Video frame level annotation results for label detection.
Fields | |
---|---|
time_offset |
Time-offset, relative to the beginning of the video, corresponding to the video frame for this location. |
confidence |
Confidence that the label is accurate. Range: [0, 1]. |
LabelSegment
Video segment level annotation results for label detection.
Fields | |
---|---|
segment |
Video segment where a label was detected. |
confidence |
Confidence that the label is accurate. Range: [0, 1]. |
Likelihood
Bucketized representation of likelihood.
Enums | |
---|---|
LIKELIHOOD_UNSPECIFIED |
Unspecified likelihood. |
VERY_UNLIKELY |
Very unlikely. |
UNLIKELY |
Unlikely. |
POSSIBLE |
Possible. |
LIKELY |
Likely. |
VERY_LIKELY |
Very likely. |
NormalizedBoundingBox
Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1].
Fields | |
---|---|
left |
Left X coordinate. |
top |
Top Y coordinate. |
right |
Right X coordinate. |
bottom |
Bottom Y coordinate. |
NormalizedBoundingPoly
Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2
When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0
and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box.
Fields | |
---|---|
vertices[] |
Normalized vertices of the bounding polygon. |
NormalizedVertex
A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
Fields | |
---|---|
x |
X coordinate. |
y |
Y coordinate. |
ObjectTrackingAnnotation
Annotations corresponding to one tracked object.
Fields | ||
---|---|---|
entity |
Entity to specify the object category that this track is labeled as. |
|
confidence |
Object category's labeling confidence of this track. |
|
frames[] |
Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames. |
|
Union field track_info . Different representation of tracking info in non-streaming batch and streaming modes. track_info can be only one of the following: |
||
segment |
Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears. |
|
track_id |
Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time. |
ObjectTrackingFrame
Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence.
Fields | |
---|---|
normalized_bounding_box |
The normalized bounding box location of this object track for the frame. |
time_offset |
The timestamp of the frame in microseconds. |
ShotChangeDetectionConfig
Config for SHOT_CHANGE_DETECTION.
Fields | |
---|---|
model |
Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". |
SpeechContext
Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
Fields | |
---|---|
phrases[] |
Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits. |
SpeechRecognitionAlternative
Alternative hypotheses (a.k.a. n-best list).
Fields | |
---|---|
transcript |
Transcript text representing the words that the user spoke. |
confidence |
The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is typically provided only for the top hypothesis, and only for |
words[] |
A list of word-specific information for each recognized word. |
SpeechTranscription
A speech recognition result corresponding to a portion of the audio.
Fields | |
---|---|
alternatives[] |
May contain one or more recognition hypotheses (up to the maximum specified in |
language_code |
Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio. |
SpeechTranscriptionConfig
Config for SPEECH_TRANSCRIPTION.
Fields | |
---|---|
language_code |
Required The language of the supplied audio as a BCP-47 language tag. Example: "en-US". See Language Support for a list of the currently supported language codes. |
max_alternatives |
Optional Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of |
filter_profanity |
Optional If set to |
speech_contexts[] |
Optional A means to provide context to assist the speech recognition. |
enable_automatic_punctuation |
Optional If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." |
audio_tracks[] |
Optional For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. |
enable_speaker_diarization |
Optional If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. |
diarization_speaker_count |
Optional If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. |
enable_word_confidence |
Optional If |
TextAnnotation
Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection.
Fields | |
---|---|
text |
The detected text. |
segments[] |
All video segments where OCR detected text appears. |
TextDetectionConfig
Config for TEXT_DETECTION.
Fields | |
---|---|
language_hints[] |
Language hint can be specified if the language to be detected is known a priori. It can increase the accuracy of the detection. Language hint must be language code in BCP-47 format. Automatic language detection is performed if no hint is provided. |
TextFrame
Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets.
Fields | |
---|---|
rotated_bounding_box |
Bounding polygon of the detected text for this frame. |
time_offset |
Timestamp of this frame. |
TextSegment
Video segment level annotation results for text detection.
Fields | |
---|---|
segment |
Video segment where a text snippet was detected. |
confidence |
Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears. |
frames[] |
Information related to the frames where OCR detected text appears. |
VideoAnnotationProgress
Annotation progress for a single video.
Fields | |
---|---|
input_uri |
Video file location in Google Cloud Storage. |
progress_percent |
Approximate percentage processed thus far. Guaranteed to be 100 when fully processed. |
start_time |
Time when the request was received. |
update_time |
Time of the most recent update. |
VideoAnnotationResults
Annotation results for a single video.
Fields | |
---|---|
input_uri |
Video file location in Google Cloud Storage. |
segment_label_annotations[] |
Label annotations on video level or user specified segment level. There is exactly one element for each unique label. |
shot_label_annotations[] |
Label annotations on shot level. There is exactly one element for each unique label. |
frame_label_annotations[] |
Label annotations on frame level. There is exactly one element for each unique label. |
shot_annotations[] |
Shot annotations. Each shot is represented as a video segment. |
explicit_annotation |
Explicit content annotation. |
speech_transcriptions[] |
Speech transcription. |
text_annotations[] |
OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it. |
object_annotations[] |
Annotations for list of objects detected and tracked in video. |
error |
If set, indicates an error. Note that for a single |
VideoContext
Video context and/or feature-specific parameters.
Fields | |
---|---|
segments[] |
Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. |
label_detection_config |
Config for LABEL_DETECTION. |
shot_change_detection_config |
Config for SHOT_CHANGE_DETECTION. |
explicit_content_detection_config |
Config for EXPLICIT_CONTENT_DETECTION. |
speech_transcription_config |
Config for SPEECH_TRANSCRIPTION. |
text_detection_config |
Config for TEXT_DETECTION. |
VideoSegment
Video segment.
Fields | |
---|---|
start_time_offset |
Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive). |
end_time_offset |
Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive). |
WordInfo
Word-specific information for recognized words. Word information is only included in the response when certain request parameters are set, such as enable_word_time_offsets
.
Fields | |
---|---|
start_time |
Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if |
end_time |
Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if |
word |
The word corresponding to this set of information. |
confidence |
Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating |
speaker_tag |
Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from 1 up to diarization_speaker_count, and is only set if speaker diarization is enabled. |