Get desktop application:
View/edit binary Protocol Buffers messages
Service that implements Google Cloud Video Intelligence Streaming API.
Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes. This method is only available via the gRPC API (not REST).
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.
*Required* The streaming request, which is either a streaming config or video content.
Provides information to the annotator, specifing how to process the request. The first `AnnotateStreamingVideoRequest` message must only contain a `video_config` message.
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` is the only message returned to the client by `StreamingAnnotateVideo`. A series of zero or more `StreamingAnnotateVideoResponse` messages are streamed back to the client.
If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
Streaming annotation results.
GCS 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
Service that implements Google Cloud Video Intelligence API.
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).
Video annotation request.
Input video location. Currently, only [Google Cloud Storage](https://cloud.google.com/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](/storage/docs/reference-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.
The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset.
Requested video annotation features.
Additional video context and/or feature-specific parameters.
Optional location where the output (in JSON format) should be stored. Currently, only [Google Cloud Storage](https://cloud.google.com/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](/storage/docs/reference-uris).
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.
Video annotation progress. Included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.
Progress metadata for all videos specified in `AnnotateVideoRequest`.
Video annotation response. Included in the `response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.
Annotation results for all videos specified in `AnnotateVideoRequest`.
A generic detected attribute represented by name in string format.
Used in:
,The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document.
Detected attribute confidence. Range [0, 1].
Text value of the detection result. For example, the value for "HairColor" can be "black", "blonde", etc.
Detected entity from video analysis.
Used in:
, ,Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
Textual description, e.g. `Fixed-gear bicycle`.
Language code for `description` in BCP-47 format.
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.
Used in:
,All video frames where explicit content was detected.
Config for EXPLICIT_CONTENT_DETECTION.
Used in:
Model to use for explicit content detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
Video frame level annotation results for explicit content.
Used in:
Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
Likelihood of the pornography content..
Video annotation feature.
Used in:
Unspecified.
Label detection. Detect objects, such as dog or flower.
Shot change detection.
Explicit content detection.
Speech transcription.
OCR text detection and tracking.
Object detection and tracking.
Logo detection, tracking, and recognition.
Label annotation.
Used in:
,Detected 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`.
All video segments where a label was detected.
All video frames where a label was detected.
Config for LABEL_DETECTION.
Used in:
What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels. If unspecified, defaults to `SHOT_MODE`.
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 to use for label detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
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.
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.
Label detection mode.
Used in:
Unspecified.
Detect shot-level labels.
Detect frame-level labels.
Detect both shot-level and frame-level labels.
Video frame level annotation results for label detection.
Used in:
Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
Confidence that the label is accurate. Range: [0, 1].
Video segment level annotation results for label detection.
Used in:
Video segment where a label was detected.
Confidence that the label is accurate. Range: [0, 1].
Bucketized representation of likelihood.
Used in:
Unspecified likelihood.
Very unlikely.
Unlikely.
Possible.
Likely.
Very likely.
Annotation corresponding to one detected, tracked and recognized logo class.
Used in:
Entity category information to specify the logo class that all the logo tracks within this LogoRecognitionAnnotation are recognized as.
All logo tracks where the recognized logo appears. Each track corresponds to one logo instance appearing in consecutive frames.
All video segments where the recognized logo appears. There might be multiple instances of the same logo class appearing in one VideoSegment.
Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1].
Used in:
,Left X coordinate.
Top Y coordinate.
Right X coordinate.
Bottom Y coordinate.
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.
Used in:
Normalized vertices of the bounding polygon.
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.
Used in:
X coordinate.
Y coordinate.
Annotations corresponding to one tracked object.
Used in:
,Entity to specify the object category that this track is labeled as.
Object category's labeling confidence of this track.
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.
Different representation of tracking info in non-streaming batch and streaming modes.
Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.
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.
Config for OBJECT_TRACKING.
Used in:
Model to use for object tracking. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence.
Used in:
The normalized bounding box location of this object track for the frame.
The timestamp of the frame in microseconds.
Config for SHOT_CHANGE_DETECTION.
Used in:
Model to use for shot change detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
Used in:
*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](https://cloud.google.com/speech/limits#content).
Alternative hypotheses (a.k.a. n-best list).
Used in:
Transcript text representing the words that the user spoke.
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.
A list of word-specific information for each recognized word.
A speech recognition result corresponding to a portion of the audio.
Used in:
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.
Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.
Config for SPEECH_TRANSCRIPTION.
Used in:
*Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes.
*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.
*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.
*Optional* A means to provide context to assist the speech recognition.
*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."
*Optional* For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.
*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.
*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.
*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`.
Config for AUTOML_CLASSIFICATION in streaming mode.
Used in:
Resource name of AutoML model. Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
Config for AUTOML_OBJECT_TRACKING in streaming mode.
Used in:
Resource name of AutoML model. Format: `projects/{project_id}/locations/{location_id}/models/{model_id}`
Config for EXPLICIT_CONTENT_DETECTION in streaming mode.
No customized config support.
Used in:
(message has no fields)
Streaming video annotation feature.
Used in:
Unspecified.
Label detection. Detect objects, such as dog or flower.
Shot change detection.
Explicit content detection.
Object detection and tracking.
Video classification based on AutoML model.
Object detection and tracking based on AutoML model.
Config for LABEL_DETECTION in streaming mode.
Used in:
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.
Config for STREAMING_OBJECT_TRACKING.
No customized config support.
Used in:
(message has no fields)
Config for SHOT_CHANGE_DETECTION in streaming mode.
No customized config support.
Used in:
(message has no fields)
Config for streaming storage option.
Used in:
Enable streaming storage. Default: false.
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.
Streaming annotation results corresponding to a portion of the video that is currently being processed.
Used in:
Shot annotation results. Each shot is represented as a video segment.
Label annotation results.
Explicit content annotation results.
Object tracking results.
Provides information to the annotator that specifies how to process the request.
Used in:
Requested annotation feature.
Config for requested annotation feature.
Config for STREAMING_SHOT_CHANGE_DETECTION.
Config for STREAMING_LABEL_DETECTION.
Config for STREAMING_EXPLICIT_CONTENT_DETECTION.
Config for STREAMING_OBJECT_TRACKING.
Config for STREAMING_AUTOML_CLASSIFICATION.
Config for STREAMING_AUTOML_OBJECT_TRACKING.
Streaming storage option. By default: storage is disabled.
Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection.
Used in:
The detected text.
All video segments where OCR detected text appears.
Config for TEXT_DETECTION.
Used in:
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.
Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
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.
Used in:
Bounding polygon of the detected text for this frame.
Timestamp of this frame.
Video segment level annotation results for text detection.
Used in:
Video segment where a text snippet was detected.
Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears.
Information related to the frames where OCR detected text appears.
For tracking related features, such as LOGO_RECOGNITION, FACE_DETECTION, CELEBRITY_RECOGNITION, PERSON_DETECTION. An object at time_offset with attributes, and located with normalized_bounding_box.
Used in:
Normalized Bounding box in a frame, where the object is located.
Time-offset, relative to the beginning of the video, corresponding to the video frame for this object.
Optional. The attributes of the object in the bounding box.
A track of an object instance.
Used in:
Video segment of a track.
The object with timestamp and attributes per frame in the track.
Optional. Attributes in the track level.
Optional. The confidence score of the tracked object.
Annotation progress for a single video.
Used in:
Video file location in [Google Cloud Storage](https://cloud.google.com/storage/).
Approximate percentage processed thus far. Guaranteed to be 100 when fully processed.
Time when the request was received.
Time of the most recent update.
Annotation results for a single video.
Used in:
Video file location in [Google Cloud Storage](https://cloud.google.com/storage/).
Label annotations on video level or user specified segment level. There is exactly one element for each unique label.
Label annotations on shot level. There is exactly one element for each unique label.
Label annotations on frame level. There is exactly one element for each unique label.
Shot annotations. Each shot is represented as a video segment.
Explicit content annotation.
Speech transcription.
OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.
Annotations for list of objects detected and tracked in video.
Annotations for list of logos detected, tracked and recognized in video.
If set, indicates an error. Note that for a single `AnnotateVideoRequest` some videos may succeed and some may fail.
Video context and/or feature-specific parameters.
Used in:
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.
Config for LABEL_DETECTION.
Config for SHOT_CHANGE_DETECTION.
Config for EXPLICIT_CONTENT_DETECTION.
Config for SPEECH_TRANSCRIPTION.
Config for TEXT_DETECTION.
Config for OBJECT_TRACKING.
Video segment.
Used in:
, , , , , , ,Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive).
Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).
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`.
Used in:
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.
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.
The word corresponding to this set of information.
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.
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.