Package google.cloud.videointelligence.v1p3beta1

Index

StreamingVideoIntelligenceService

Service that implements streaming Google Cloud Video Intelligence API.

StreamingAnnotateVideo

rpc StreamingAnnotateVideo(StreamingAnnotateVideoRequest) returns (StreamingAnnotateVideoResponse)

Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes. This method is only available via the gRPC API (not REST).

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

VideoIntelligenceService

Service that implements Google Cloud Video Intelligence API.

AnnotateVideo

rpc AnnotateVideo(AnnotateVideoRequest) returns (Operation)

Performs asynchronous video annotation. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains AnnotateVideoProgress (progress). Operation.response contains AnnotateVideoResponse (results).

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

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

VideoAnnotationProgress

Progress metadata for all videos specified in AnnotateVideoRequest.

AnnotateVideoRequest

Video annotation request.

Fields
input_uri

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.

input_content

bytes

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

features[]

Feature

Requested video annotation features.

video_context

VideoContext

Additional video context and/or feature-specific parameters.

output_uri

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.

location_id

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.

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

VideoAnnotationResults

Annotation results for all videos specified in AnnotateVideoRequest.

Entity

Detected entity from video analysis.

Fields
entity_id

string

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

description

string

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

language_code

string

Language code for description in BCP-47 format.

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

ExplicitContentFrame

All video frames where explicit content was detected.

ExplicitContentDetectionConfig

Config for EXPLICIT_CONTENT_DETECTION.

Fields
model

string

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

Duration

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

pornography_likelihood

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

Entity

Detected entity.

category_entities[]

Entity

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

LabelSegment

All video segments where a label was detected.

frames[]

LabelFrame

All video frames where a label was detected.

LabelDetectionConfig

Config for LABEL_DETECTION.

Fields
label_detection_mode

LabelDetectionMode

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

bool

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

frame_confidence_threshold

float

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

float

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

Duration

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

confidence

float

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

LabelSegment

Video segment level annotation results for label detection.

Fields
segment

VideoSegment

Video segment where a label was detected.

confidence

float

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

float

Left X coordinate.

top

float

Top Y coordinate.

right

float

Right X coordinate.

bottom

float

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

NormalizedVertex

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

float

X coordinate.

y

float

Y coordinate.

ObjectTrackingAnnotation

Annotations corresponding to one tracked object.

Fields
entity

Entity

Entity to specify the object category that this track is labeled as.

confidence

float

Object category's labeling confidence of this track.

frames[]

ObjectTrackingFrame

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

VideoSegment

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

track_id

int64

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

NormalizedBoundingBox

The normalized bounding box location of this object track for the frame.

time_offset

Duration

The timestamp of the frame in microseconds.

ShotChangeDetectionConfig

Config for SHOT_CHANGE_DETECTION.

Fields
model

string

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

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.

SpeechRecognitionAlternative

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

Fields
transcript

string

Transcript text representing the words that the user spoke.

confidence

float

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

WordInfo

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

SpeechTranscription

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

Fields
alternatives[]

SpeechRecognitionAlternative

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.

language_code

string

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

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.

max_alternatives

int32

Optional Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of SpeechRecognitionAlternative messages within each SpeechTranscription. 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

bool

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

SpeechContext

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

enable_automatic_punctuation

bool

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

int32

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

enable_speaker_diarization

bool

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

int32

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

bool

Optional If true, the top result includes a list of words and the confidence for those words. If false, no word-level confidence information is returned. The default is false.

StreamingAnnotateVideoRequest

The top-level message sent by the client for the StreamingAnnotateVideo method. Multiple StreamingAnnotateVideoRequest messages are sent. The first message must only contain a StreamingVideoConfig message. All subsequent messages must only contain input_content data.

Fields
Union field streaming_request. Required The streaming request, which is either a streaming config or video content. streaming_request can be only one of the following:
video_config

StreamingVideoConfig

Provides information to the annotator, specifing how to process the request. The first AnnotateStreamingVideoRequest message must only contain a video_config message.

input_content

bytes

The video data to be annotated. Chunks of video data are sequentially sent in StreamingAnnotateVideoRequest messages. Except the initial StreamingAnnotateVideoRequest message containing only video_config, all subsequent AnnotateStreamingVideoRequest messages must only contain input_content field. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64).

StreamingAnnotateVideoResponse

StreamingAnnotateVideoResponse is the only message returned to the client by StreamingAnnotateVideo. A series of zero or more StreamingAnnotateVideoResponse messages are streamed back to the client.

Fields
error

Status

If set, returns a google.rpc.Status message that specifies the error for the operation.

annotation_results

StreamingVideoAnnotationResults

Streaming annotation results.

annotation_results_uri

string

Cloud Storage URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id

StreamingExplicitContentDetectionConfig

Config for STREAMING_EXPLICIT_CONTENT_DETECTION.

StreamingFeature

Streaming video annotation feature.

Enums
STREAMING_FEATURE_UNSPECIFIED Unspecified.
STREAMING_LABEL_DETECTION Label detection. Detect objects, such as dog or flower.
STREAMING_SHOT_CHANGE_DETECTION Shot change detection.
STREAMING_EXPLICIT_CONTENT_DETECTION Explicit content detection.
STREAMING_OBJECT_TRACKING Object detection and tracking.

StreamingLabelDetectionConfig

Config for STREAMING_LABEL_DETECTION.

Fields
stationary_camera

bool

Whether the video has been captured from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Default: false.

StreamingObjectTrackingConfig

Config for STREAMING_OBJECT_TRACKING.

StreamingShotChangeDetectionConfig

Config for STREAMING_SHOT_CHANGE_DETECTION.

StreamingStorageConfig

Config for streaming storage option.

Fields
enable_storage_annotation_result

bool

Enable streaming storage. Default: false.

annotation_result_storage_directory

string

GCS URI to store all annotation results for one client. Client should specify this field as the top-level storage directory. Annotation results of different sessions will be put into different sub-directories denoted by project_name and session_id. All sub-directories will be auto generated by program and will be made accessible to client in response proto. URIs must be specified in the following format: gs://bucket-id/object-id bucket-id should be a valid GCS bucket created by client and bucket permission shall also be configured properly. object-id can be arbitrary string that make sense to client. Other URI formats will return error and cause GCS write failure.

StreamingVideoAnnotationResults

Streaming annotation results corresponding to a portion of the video that is currently being processed.

Fields
shot_annotations[]

VideoSegment

Shot annotation results. Each shot is represented as a video segment.

label_annotations[]

LabelAnnotation

Label annotation results.

explicit_annotation

ExplicitContentAnnotation

Explicit content annotation results.

object_annotations[]

ObjectTrackingAnnotation

Object tracking results.

StreamingVideoConfig

Provides information to the annotator that specifies how to process the request.

Fields
feature

StreamingFeature

Requested annotation feature.

storage_config

StreamingStorageConfig

Streaming storage option. By default: storage is disabled.

Union field streaming_config. Config for requested annotation feature. streaming_config can be only one of the following:
shot_change_detection_config

StreamingShotChangeDetectionConfig

Config for STREAMING_SHOT_CHANGE_DETECTION.

label_detection_config

StreamingLabelDetectionConfig

Config for STREAMING_LABEL_DETECTION.

explicit_content_detection_config

StreamingExplicitContentDetectionConfig

Config for STREAMING_EXPLICIT_CONTENT_DETECTION.

object_tracking_config

StreamingObjectTrackingConfig

Config for STREAMING_OBJECT_TRACKING.

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

string

The detected text.

segments[]

TextSegment

All video segments where OCR detected text appears.

TextDetectionConfig

Config for TEXT_DETECTION.

Fields
language_hints[]

string

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

NormalizedBoundingPoly

Bounding polygon of the detected text for this frame.

time_offset

Duration

Timestamp of this frame.

TextSegment

Video segment level annotation results for text detection.

Fields
segment

VideoSegment

Video segment where a text snippet was detected.

confidence

float

Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears.

frames[]

TextFrame

Information related to the frames where OCR detected text appears.

VideoAnnotationProgress

Annotation progress for a single video.

Fields
input_uri

string

Video file location in Google Cloud Storage.

progress_percent

int32

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

start_time

Timestamp

Time when the request was received.

update_time

Timestamp

Time of the most recent update.

VideoAnnotationResults

Annotation results for a single video.

Fields
input_uri

string

Video file location in Google Cloud Storage.

segment_label_annotations[]

LabelAnnotation

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

shot_label_annotations[]

LabelAnnotation

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

frame_label_annotations[]

LabelAnnotation

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

shot_annotations[]

VideoSegment

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

explicit_annotation

ExplicitContentAnnotation

Explicit content annotation.

speech_transcriptions[]

SpeechTranscription

Speech transcription.

text_annotations[]

TextAnnotation

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

object_annotations[]

ObjectTrackingAnnotation

Annotations for list of objects detected and tracked in video.

error

Status

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

VideoContext

Video context and/or feature-specific parameters.

Fields
segments[]

VideoSegment

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

LabelDetectionConfig

Config for LABEL_DETECTION.

shot_change_detection_config

ShotChangeDetectionConfig

Config for SHOT_CHANGE_DETECTION.

explicit_content_detection_config

ExplicitContentDetectionConfig

Config for EXPLICIT_CONTENT_DETECTION.

speech_transcription_config

SpeechTranscriptionConfig

Config for SPEECH_TRANSCRIPTION.

text_detection_config

TextDetectionConfig

Config for TEXT_DETECTION.

VideoSegment

Video segment.

Fields
start_time_offset

Duration

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

end_time_offset

Duration

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

Duration

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

Duration

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

string

The word corresponding to this set of information.

confidence

float

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 confidence was not set.

speaker_tag

int32

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.

Kunde den här sidan hjälpa dig? Berätta:

Skicka feedback om ...

Cloud Video Intelligence API