package google.cloud.videointelligence.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Service that implements Google Cloud Video Intelligence API.

• rpc AnnotateVideo (AnnotateVideoRequest, longrunning.Operation)

  video_intelligence.proto:39

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

  message AnnotateVideoRequest

  video_intelligence.proto:45

  Video annotation request.

  • string input_uri = 1

    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.

  • bytes input_content = 6

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

  • repeated Feature features = 2

    Requested video annotation features.

  • optional VideoContext video_context = 3

    Additional video context and/or feature-specific parameters.

  • string output_uri = 4

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

  • string location_id = 5

    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.

• repeated VideoAnnotationProgress annotation_progress = 1

  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.

• repeated VideoAnnotationResults annotation_results = 1

  Annotation results for all videos specified in `AnnotateVideoRequest`.

Detected entity from video analysis.

Used in: LabelAnnotation

• string entity_id = 1

  Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).

• string description = 2

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

• string language_code = 3

  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: VideoAnnotationResults

• repeated ExplicitContentFrame frames = 1

  All video frames where explicit content was detected.

Config for EXPLICIT_CONTENT_DETECTION.

Used in: VideoContext

• string model = 1

  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: ExplicitContentAnnotation

• optional protobuf.Duration time_offset = 1

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

• Likelihood pornography_likelihood = 2

  Likelihood of the pornography content..

Face annotation.

Used in: VideoAnnotationResults

• bytes thumbnail = 1

  Thumbnail of a representative face view (in JPEG format).

• repeated FaceSegment segments = 2

  All video segments where a face was detected.

• repeated FaceFrame frames = 3

  All video frames where a face was detected.

Config for FACE_DETECTION.

Used in: VideoContext

• string model = 1

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

• bool include_bounding_boxes = 2

  Whether bounding boxes be included in the face annotation output.

Video frame level annotation results for face detection.

Used in: FaceAnnotation

• repeated NormalizedBoundingBox normalized_bounding_boxes = 1

  Normalized Bounding boxes in a frame. There can be more than one boxes if the same face is detected in multiple locations within the current frame.

• optional protobuf.Duration time_offset = 2

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

Video segment level annotation results for face detection.

Used in: FaceAnnotation

• optional VideoSegment segment = 1

  Video segment where a face was detected.

Video annotation feature.

Used in: AnnotateVideoRequest

• FEATURE_UNSPECIFIED = 0

  Unspecified.

• LABEL_DETECTION = 1

  Label detection. Detect objects, such as dog or flower.

• SHOT_CHANGE_DETECTION = 2

  Shot change detection.

• EXPLICIT_CONTENT_DETECTION = 3

  Explicit content detection.

• FACE_DETECTION = 4

  Human face detection and tracking.

Label annotation.

Used in: VideoAnnotationResults

• optional Entity entity = 1

  Detected entity.

• repeated Entity category_entities = 2

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

• repeated LabelSegment segments = 3

  All video segments where a label was detected.

• repeated LabelFrame frames = 4

  All video frames where a label was detected.

Config for LABEL_DETECTION.

Used in: VideoContext

• LabelDetectionMode label_detection_mode = 1

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

• bool stationary_camera = 2

  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.

• string model = 3

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

Label detection mode.

Used in: LabelDetectionConfig

• LABEL_DETECTION_MODE_UNSPECIFIED = 0

  Unspecified.

• SHOT_MODE = 1

  Detect shot-level labels.

• FRAME_MODE = 2

  Detect frame-level labels.

• SHOT_AND_FRAME_MODE = 3

  Detect both shot-level and frame-level labels.

Video frame level annotation results for label detection.

Used in: LabelAnnotation

• optional protobuf.Duration time_offset = 1

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

• float confidence = 2

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

Video segment level annotation results for label detection.

Used in: LabelAnnotation

• optional VideoSegment segment = 1

  Video segment where a label was detected.

• float confidence = 2

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

Bucketized representation of likelihood.

Used in: ExplicitContentFrame

• LIKELIHOOD_UNSPECIFIED = 0

  Unspecified likelihood.

• VERY_UNLIKELY = 1

  Very unlikely.

• UNLIKELY = 2

  Unlikely.

• POSSIBLE = 3

  Possible.

• LIKELY = 4

  Likely.

• VERY_LIKELY = 5

  Very likely.

Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1].

Used in: FaceFrame

• float left = 1

  Left X coordinate.

• float top = 2

  Top Y coordinate.

• float right = 3

  Right X coordinate.

• float bottom = 4

  Bottom Y coordinate.

Config for SHOT_CHANGE_DETECTION.

Used in: VideoContext

• string model = 1

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

Annotation progress for a single video.

Used in: AnnotateVideoProgress

• string input_uri = 1

  Video file location in [Google Cloud Storage](https://cloud.google.com/storage/).

• int32 progress_percent = 2

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

• optional protobuf.Timestamp start_time = 3

  Time when the request was received.

• optional protobuf.Timestamp update_time = 4

  Time of the most recent update.

Annotation results for a single video.

Used in: AnnotateVideoResponse

• string input_uri = 1

  Video file location in [Google Cloud Storage](https://cloud.google.com/storage/).

• repeated LabelAnnotation segment_label_annotations = 2

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

• repeated LabelAnnotation shot_label_annotations = 3

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

• repeated LabelAnnotation frame_label_annotations = 4

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

• repeated FaceAnnotation face_annotations = 5

  Face annotations. There is exactly one element for each unique face.

• repeated VideoSegment shot_annotations = 6

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

• optional ExplicitContentAnnotation explicit_annotation = 7

  Explicit content annotation.

• optional rpc.Status error = 9

  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: AnnotateVideoRequest

• repeated VideoSegment segments = 1

  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.

• optional LabelDetectionConfig label_detection_config = 2

  Config for LABEL_DETECTION.

• optional ShotChangeDetectionConfig shot_change_detection_config = 3

  Config for SHOT_CHANGE_DETECTION.

• optional ExplicitContentDetectionConfig explicit_content_detection_config = 4

  Config for EXPLICIT_CONTENT_DETECTION.

• optional FaceDetectionConfig face_detection_config = 5

  Config for FACE_DETECTION.

Video segment.

Used in: FaceSegment, LabelSegment, VideoAnnotationResults, VideoContext

• optional protobuf.Duration start_time_offset = 1

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

• optional protobuf.Duration end_time_offset = 2

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