Enumerations

Feature

constant   static

number

Video annotation feature.

Value

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.

LabelDetectionMode

constant   static

number

Label detection mode.

Value

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.

Likelihood

constant   static

number

Bucketized representation of likelihood.

Value

LIKELIHOOD_UNSPECIFIED

Unspecified likelihood.

VERY_UNLIKELY

Very unlikely.

UNLIKELY

Unlikely.

POSSIBLE

Possible.

LIKELY

Likely.

VERY_LIKELY

Very likely.

Properties

Feature

constant   static

number

Video annotation feature.

Value

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.

LabelDetectionMode

constant   static

number

Label detection mode.

Value

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.

Likelihood

constant   static

number

Bucketized representation of likelihood.

Value

LIKELIHOOD_UNSPECIFIED

Unspecified likelihood.

VERY_UNLIKELY

Very unlikely.

UNLIKELY

Unlikely.

POSSIBLE

Possible.

LIKELY

Likely.

VERY_LIKELY

Very likely.

Abstract types

AnnotateVideoProgress

static

Video annotation progress. Included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Property

Parameter

annotationProgress

Array of Object

Progress metadata for all videos specified in AnnotateVideoRequest.

This object should have the same structure as VideoAnnotationProgress

See also

google.cloud.videointelligence.v1p1beta1.AnnotateVideoProgress definition in proto format

AnnotateVideoRequest

static

Video annotation request.

Properties

Parameter

inputUri

string

Input video location. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs. A video URI may include wildcards in object-id, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as input_content. If set, input_content should be unset.

inputContent

string

The video data bytes. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

features

Array of number

Requested video annotation features.

The number should be among the values of Feature

videoContext

Object

Additional video context and/or feature-specific parameters.

This object should have the same structure as VideoContext

outputUri

string

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: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs.

locationId

string

Optional cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

See also

google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest definition in proto format

AnnotateVideoResponse

static

Video annotation response. Included in the response field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Property

Parameter

annotationResults

Array of Object

Annotation results for all videos specified in AnnotateVideoRequest.

This object should have the same structure as VideoAnnotationResults

See also

google.cloud.videointelligence.v1p1beta1.AnnotateVideoResponse definition in proto format

Entity

static

Detected entity from video analysis.

Properties

Parameter

entityId

string

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.

description

string

Textual description, e.g. Fixed-gear bicycle.

languageCode

string

Language code for description in BCP-47 format.

See also

google.cloud.videointelligence.v1p1beta1.Entity definition in proto format

ExplicitContentAnnotation

static

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.

Property

Parameter

frames

Array of Object

All video frames where explicit content was detected.

This object should have the same structure as ExplicitContentFrame

See also

google.cloud.videointelligence.v1p1beta1.ExplicitContentAnnotation definition in proto format

ExplicitContentDetectionConfig

static

Config for EXPLICIT_CONTENT_DETECTION.

Property

Parameter

model

string

Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".

See also

google.cloud.videointelligence.v1p1beta1.ExplicitContentDetectionConfig definition in proto format

ExplicitContentFrame

static

Video frame level annotation results for explicit content.

Properties

Parameter

timeOffset

Object

Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.

This object should have the same structure as Duration

pornographyLikelihood

number

Likelihood of the pornography content..

The number should be among the values of Likelihood

See also

google.cloud.videointelligence.v1p1beta1.ExplicitContentFrame definition in proto format

LabelAnnotation

static

Label annotation.

Properties

Parameter

entity

Object

Detected entity.

This object should have the same structure as Entity

categoryEntities

Array of Object

Common categories for the detected entity. E.g. when the label is Terrier the category is likely dog. And in some cases there might be more than one categories e.g. Terrier could also be a pet.

This object should have the same structure as Entity

segments

Array of Object

All video segments where a label was detected.

This object should have the same structure as LabelSegment

frames

Array of Object

All video frames where a label was detected.

This object should have the same structure as LabelFrame

See also

google.cloud.videointelligence.v1p1beta1.LabelAnnotation definition in proto format

LabelDetectionConfig

static

Config for LABEL_DETECTION.

Properties

Parameter

labelDetectionMode

number

What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to SHOT_MODE.

The number should be among the values of LabelDetectionMode

stationaryCamera

boolean

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 SHOT_AND_FRAME_MODE enabled.

model

string

Model to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".

See also

google.cloud.videointelligence.v1p1beta1.LabelDetectionConfig definition in proto format

LabelFrame

static

Video frame level annotation results for label detection.

Properties

Parameter

timeOffset

Object

Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.

This object should have the same structure as Duration

confidence

number

Confidence that the label is accurate. Range: [0, 1].

See also

google.cloud.videointelligence.v1p1beta1.LabelFrame definition in proto format

LabelSegment

static

Video segment level annotation results for label detection.

Properties

Parameter

segment

Object

Video segment where a label was detected.

This object should have the same structure as VideoSegment

confidence

number

Confidence that the label is accurate. Range: [0, 1].

See also

google.cloud.videointelligence.v1p1beta1.LabelSegment definition in proto format

ShotChangeDetectionConfig

static

Config for SHOT_CHANGE_DETECTION.

Property

Parameter

model

string

Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".

See also

google.cloud.videointelligence.v1p1beta1.ShotChangeDetectionConfig definition in proto format

SpeechContext

static

Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

Property

Parameter

phrases

Array of string

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.

See also

google.cloud.videointelligence.v1p1beta1.SpeechContext definition in proto format

SpeechRecognitionAlternative

static

Alternative hypotheses (a.k.a. n-best list).

Properties

Parameter

transcript

string

Output only. Transcript text representing the words that the user spoke.

confidence

number

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 typically provided only for the top hypothesis, and only for is_final=true results. Clients should not rely on the confidence field as it is not guaranteed to be accurate or consistent. The default of 0.0 is a sentinel value indicating confidence was not set.

words

Array of Object

Output only. A list of word-specific information for each recognized word.

This object should have the same structure as WordInfo

See also

google.cloud.videointelligence.v1p1beta1.SpeechRecognitionAlternative definition in proto format

SpeechTranscription

static

A speech recognition result corresponding to a portion of the audio.

Property

Parameter

alternatives

Array of Object

Output only. May contain one or more recognition hypotheses (up to the maximum specified in max_alternatives). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.

This object should have the same structure as SpeechRecognitionAlternative

See also

google.cloud.videointelligence.v1p1beta1.SpeechTranscription definition in proto format

SpeechTranscriptionConfig

static

Config for SPEECH_TRANSCRIPTION.

Properties

Parameter

languageCode

string

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.

maxAlternatives

number

Optional Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of SpeechRecognitionAlternative messages within each SpeechRecognitionResult. The server may return fewer than max_alternatives. Valid values are 0-30. A value of 0 or 1 will return a maximum of one. If omitted, will return a maximum of one.

filterProfanity

boolean

Optional If set to true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to false or omitted, profanities won't be filtered out.

speechContexts

Array of Object

Optional A means to provide context to assist the speech recognition.

This object should have the same structure as SpeechContext

enableAutomaticPunctuation

boolean

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."

audioTracks

Array of number

Optional For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.

See also

google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig definition in proto format

VideoAnnotationProgress

static

Annotation progress for a single video.

Properties

Parameter

inputUri

string

Output only. Video file location in Google Cloud Storage.

progressPercent

number

Output only. Approximate percentage processed thus far. Guaranteed to be 100 when fully processed.

startTime

Object

Output only. Time when the request was received.

This object should have the same structure as Timestamp

updateTime

Object

Output only. Time of the most recent update.

This object should have the same structure as Timestamp

See also

google.cloud.videointelligence.v1p1beta1.VideoAnnotationProgress definition in proto format

VideoAnnotationResults

static

Annotation results for a single video.

Properties

Parameter

inputUri

string

Output only. Video file location in Google Cloud Storage.

segmentLabelAnnotations

Array of Object

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

This object should have the same structure as LabelAnnotation

shotLabelAnnotations

Array of Object

Label annotations on shot level. There is exactly one element for each unique label.

This object should have the same structure as LabelAnnotation

frameLabelAnnotations

Array of Object

Label annotations on frame level. There is exactly one element for each unique label.

This object should have the same structure as LabelAnnotation

shotAnnotations

Array of Object

Shot annotations. Each shot is represented as a video segment.

This object should have the same structure as VideoSegment

explicitAnnotation

Object

Explicit content annotation.

This object should have the same structure as ExplicitContentAnnotation

speechTranscriptions

Array of Object

Speech transcription.

This object should have the same structure as SpeechTranscription

error

Object

Output only. If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

This object should have the same structure as Status

See also

google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults definition in proto format

VideoContext

static

Video context and/or feature-specific parameters.

Properties

Parameter

segments

Array of Object

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.

This object should have the same structure as VideoSegment

labelDetectionConfig

Object

Config for LABEL_DETECTION.

This object should have the same structure as LabelDetectionConfig

shotChangeDetectionConfig

Object

Config for SHOT_CHANGE_DETECTION.

This object should have the same structure as ShotChangeDetectionConfig

explicitContentDetectionConfig

Object

Config for EXPLICIT_CONTENT_DETECTION.

This object should have the same structure as ExplicitContentDetectionConfig

speechTranscriptionConfig

Object

Config for SPEECH_TRANSCRIPTION.

This object should have the same structure as SpeechTranscriptionConfig

See also

google.cloud.videointelligence.v1p1beta1.VideoContext definition in proto format

VideoSegment

static

Video segment.

Properties

Parameter

startTimeOffset

Object

Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive).

This object should have the same structure as Duration

endTimeOffset

Object

Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).

This object should have the same structure as Duration

See also

google.cloud.videointelligence.v1p1beta1.VideoSegment definition in proto format

WordInfo

static

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.

Properties

Parameter

startTime

Object

Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

This object should have the same structure as Duration

endTime

Object

Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if enable_word_time_offsets=true and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.

This object should have the same structure as Duration

word

string

Output only. The word corresponding to this set of information.

See also

google.cloud.videointelligence.v1p1beta1.WordInfo definition in proto format