Types for Cloud Video Intelligence API Client#

class google.cloud.videointelligence_v1p1beta1.types.AnnotateVideoProgress#

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

annotation_progress#

Progress metadata for all videos specified in AnnotateVideoRequest.

annotation_progress

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoProgress.annotation_progress

class google.cloud.videointelligence_v1p1beta1.types.AnnotateVideoRequest#

Video annotation request.

input_uri#

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][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.

input_content#

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

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

location_id#

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.

features

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest.features

input_content

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest.input_content

input_uri

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest.input_uri

location_id

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest.location_id

output_uri

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest.output_uri

video_context

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoRequest.video_context

class google.cloud.videointelligence_v1p1beta1.types.AnnotateVideoResponse#

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

annotation_results#

Annotation results for all videos specified in AnnotateVideoRequest.

annotation_results

Field google.cloud.videointelligence.v1p1beta1.AnnotateVideoResponse.annotation_results

class google.cloud.videointelligence_v1p1beta1.types.Any#
type_url#

Field google.protobuf.Any.type_url

value#

Field google.protobuf.Any.value

class google.cloud.videointelligence_v1p1beta1.types.CancelOperationRequest#
name#

Field google.longrunning.CancelOperationRequest.name

class google.cloud.videointelligence_v1p1beta1.types.DeleteOperationRequest#
name#

Field google.longrunning.DeleteOperationRequest.name

class google.cloud.videointelligence_v1p1beta1.types.Duration#
nanos#

Field google.protobuf.Duration.nanos

seconds#

Field google.protobuf.Duration.seconds

class google.cloud.videointelligence_v1p1beta1.types.Entity#

Detected entity from video analysis.

entity_id#

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

description#

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

language_code#

Language code for description in BCP-47 format.

description

Field google.cloud.videointelligence.v1p1beta1.Entity.description

entity_id

Field google.cloud.videointelligence.v1p1beta1.Entity.entity_id

language_code

Field google.cloud.videointelligence.v1p1beta1.Entity.language_code

class google.cloud.videointelligence_v1p1beta1.types.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.

frames#

All video frames where explicit content was detected.

frames

Field google.cloud.videointelligence.v1p1beta1.ExplicitContentAnnotation.frames

class google.cloud.videointelligence_v1p1beta1.types.ExplicitContentDetectionConfig#

Config for EXPLICIT_CONTENT_DETECTION.

model#

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

model

Field google.cloud.videointelligence.v1p1beta1.ExplicitContentDetectionConfig.model

class google.cloud.videointelligence_v1p1beta1.types.ExplicitContentFrame#

Video frame level annotation results for explicit content.

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

pornography_likelihood

Field google.cloud.videointelligence.v1p1beta1.ExplicitContentFrame.pornography_likelihood

time_offset

Field google.cloud.videointelligence.v1p1beta1.ExplicitContentFrame.time_offset

class google.cloud.videointelligence_v1p1beta1.types.GetOperationRequest#
name#

Field google.longrunning.GetOperationRequest.name

class google.cloud.videointelligence_v1p1beta1.types.LabelAnnotation#

Label annotation.

entity#

Detected entity.

category_entities#

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.

segments#

All video segments where a label was detected.

frames#

All video frames where a label was detected.

category_entities

Field google.cloud.videointelligence.v1p1beta1.LabelAnnotation.category_entities

entity

Field google.cloud.videointelligence.v1p1beta1.LabelAnnotation.entity

frames

Field google.cloud.videointelligence.v1p1beta1.LabelAnnotation.frames

segments

Field google.cloud.videointelligence.v1p1beta1.LabelAnnotation.segments

class google.cloud.videointelligence_v1p1beta1.types.LabelDetectionConfig#

Config for LABEL_DETECTION.

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

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

model#

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

label_detection_mode

Field google.cloud.videointelligence.v1p1beta1.LabelDetectionConfig.label_detection_mode

model

Field google.cloud.videointelligence.v1p1beta1.LabelDetectionConfig.model

stationary_camera

Field google.cloud.videointelligence.v1p1beta1.LabelDetectionConfig.stationary_camera

class google.cloud.videointelligence_v1p1beta1.types.LabelFrame#

Video frame level annotation results for label detection.

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

confidence

Field google.cloud.videointelligence.v1p1beta1.LabelFrame.confidence

time_offset

Field google.cloud.videointelligence.v1p1beta1.LabelFrame.time_offset

class google.cloud.videointelligence_v1p1beta1.types.LabelSegment#

Video segment level annotation results for label detection.

segment#

Video segment where a label was detected.

confidence#

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

confidence

Field google.cloud.videointelligence.v1p1beta1.LabelSegment.confidence

segment

Field google.cloud.videointelligence.v1p1beta1.LabelSegment.segment

class google.cloud.videointelligence_v1p1beta1.types.ListOperationsRequest#
filter#

Field google.longrunning.ListOperationsRequest.filter

name#

Field google.longrunning.ListOperationsRequest.name

page_size#

Field google.longrunning.ListOperationsRequest.page_size

page_token#

Field google.longrunning.ListOperationsRequest.page_token

class google.cloud.videointelligence_v1p1beta1.types.ListOperationsResponse#
next_page_token#

Field google.longrunning.ListOperationsResponse.next_page_token

operations#

Field google.longrunning.ListOperationsResponse.operations

class google.cloud.videointelligence_v1p1beta1.types.Operation#
deserialize()#

Creates new method instance from given serialized data.

done#

Field google.longrunning.Operation.done

error#

Field google.longrunning.Operation.error

metadata#

Field google.longrunning.Operation.metadata

name#

Field google.longrunning.Operation.name

response#

Field google.longrunning.Operation.response

class google.cloud.videointelligence_v1p1beta1.types.OperationInfo#
metadata_type#

Field google.longrunning.OperationInfo.metadata_type

response_type#

Field google.longrunning.OperationInfo.response_type

class google.cloud.videointelligence_v1p1beta1.types.ShotChangeDetectionConfig#

Config for SHOT_CHANGE_DETECTION.

model#

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

model

Field google.cloud.videointelligence.v1p1beta1.ShotChangeDetectionConfig.model

class google.cloud.videointelligence_v1p1beta1.types.SpeechContext#

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

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.

phrases

Field google.cloud.videointelligence.v1p1beta1.SpeechContext.phrases

class google.cloud.videointelligence_v1p1beta1.types.SpeechRecognitionAlternative#

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

transcript#

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

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 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#

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

confidence

Field google.cloud.videointelligence.v1p1beta1.SpeechRecognitionAlternative.confidence

transcript

Field google.cloud.videointelligence.v1p1beta1.SpeechRecognitionAlternative.transcript

words

Field google.cloud.videointelligence.v1p1beta1.SpeechRecognitionAlternative.words

class google.cloud.videointelligence_v1p1beta1.types.SpeechTranscription#

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

alternatives#

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.

alternatives

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscription.alternatives

class google.cloud.videointelligence_v1p1beta1.types.SpeechTranscriptionConfig#

Config for SPEECH_TRANSCRIPTION.

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

filter_profanity#

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.

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.

audio_tracks

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig.audio_tracks

enable_automatic_punctuation

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig.enable_automatic_punctuation

filter_profanity

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig.filter_profanity

language_code

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig.language_code

max_alternatives

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig.max_alternatives

speech_contexts

Field google.cloud.videointelligence.v1p1beta1.SpeechTranscriptionConfig.speech_contexts

class google.cloud.videointelligence_v1p1beta1.types.Status#
code#

Field google.rpc.Status.code

details#

Field google.rpc.Status.details

message#

Field google.rpc.Status.message

class google.cloud.videointelligence_v1p1beta1.types.Timestamp#
nanos#

Field google.protobuf.Timestamp.nanos

seconds#

Field google.protobuf.Timestamp.seconds

class google.cloud.videointelligence_v1p1beta1.types.VideoAnnotationProgress#

Annotation progress for a single video.

input_uri#

Output only. Video file location in Google Cloud Storage.

progress_percent#

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

start_time#

Output only. Time when the request was received.

update_time#

Output only. Time of the most recent update.

input_uri

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationProgress.input_uri

progress_percent

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationProgress.progress_percent

start_time

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationProgress.start_time

update_time

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationProgress.update_time

class google.cloud.videointelligence_v1p1beta1.types.VideoAnnotationResults#

Annotation results for a single video.

input_uri#

Output only. 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.

error#

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

error

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.error

explicit_annotation

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.explicit_annotation

frame_label_annotations

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.frame_label_annotations

input_uri

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.input_uri

segment_label_annotations

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.segment_label_annotations

shot_annotations

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.shot_annotations

shot_label_annotations

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.shot_label_annotations

speech_transcriptions

Field google.cloud.videointelligence.v1p1beta1.VideoAnnotationResults.speech_transcriptions

class google.cloud.videointelligence_v1p1beta1.types.VideoContext#

Video context and/or feature-specific parameters.

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.

explicit_content_detection_config

Field google.cloud.videointelligence.v1p1beta1.VideoContext.explicit_content_detection_config

label_detection_config

Field google.cloud.videointelligence.v1p1beta1.VideoContext.label_detection_config

segments

Field google.cloud.videointelligence.v1p1beta1.VideoContext.segments

shot_change_detection_config

Field google.cloud.videointelligence.v1p1beta1.VideoContext.shot_change_detection_config

speech_transcription_config

Field google.cloud.videointelligence.v1p1beta1.VideoContext.speech_transcription_config

class google.cloud.videointelligence_v1p1beta1.types.VideoSegment#

Video segment.

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

end_time_offset

Field google.cloud.videointelligence.v1p1beta1.VideoSegment.end_time_offset

start_time_offset

Field google.cloud.videointelligence.v1p1beta1.VideoSegment.start_time_offset

class google.cloud.videointelligence_v1p1beta1.types.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.

start_time#

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.

end_time#

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.

word#

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

end_time

Field google.cloud.videointelligence.v1p1beta1.WordInfo.end_time

start_time

Field google.cloud.videointelligence.v1p1beta1.WordInfo.start_time

word

Field google.cloud.videointelligence.v1p1beta1.WordInfo.word