Package types (2.3.3)

Stay organized with collections Save and categorize content based on your preferences.

API documentation for videointelligence_v1p2beta1.types package.

Classes

AnnotateVideoProgress

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

AnnotateVideoRequest

Video annotation request. .. attribute:: input_uri

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 <https://cloud.google.com/storage/docs/request-endpoints>. 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.

:type: str

AnnotateVideoResponse

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

Entity

Detected entity from video analysis. .. attribute:: entity_id

Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API <https://developers.google.com/knowledge-graph/>__.

:type: str

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.

ExplicitContentDetectionConfig

Config for EXPLICIT_CONTENT_DETECTION. .. attribute:: model

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

:type: str

ExplicitContentFrame

Video frame level annotation results for explicit content. .. attribute:: time_offset

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

:type: google.protobuf.duration_pb2.Duration

Feature

Video annotation feature.

LabelAnnotation

Label annotation. .. attribute:: entity

Detected entity.

:type: google.cloud.videointelligence_v1p2beta1.types.Entity

LabelDetectionConfig

Config for LABEL_DETECTION. .. attribute:: 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.

:type: google.cloud.videointelligence_v1p2beta1.types.LabelDetectionMode

LabelDetectionMode

Label detection mode.

LabelFrame

Video frame level annotation results for label detection. .. attribute:: time_offset

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

:type: google.protobuf.duration_pb2.Duration

LabelSegment

Video segment level annotation results for label detection. .. attribute:: segment

Video segment where a label was detected.

:type: google.cloud.videointelligence_v1p2beta1.types.VideoSegment

Likelihood

Bucketized representation of likelihood.

NormalizedBoundingBox

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

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.

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.

ObjectTrackingAnnotation

Annotations corresponding to one tracked object. .. attribute:: entity

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

:type: google.cloud.videointelligence_v1p2beta1.types.Entity

ObjectTrackingFrame

Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence.

ShotChangeDetectionConfig

Config for SHOT_CHANGE_DETECTION. .. attribute:: model

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

:type: str

TextAnnotation

Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection.

TextDetectionConfig

Config for TEXT_DETECTION. .. attribute:: language_hints

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.

:type: Sequence[str]

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.

TextSegment

Video segment level annotation results for text detection. .. attribute:: segment

Video segment where a text snippet was detected.

:type: google.cloud.videointelligence_v1p2beta1.types.VideoSegment

VideoAnnotationProgress

Annotation progress for a single video. .. attribute:: input_uri

Video file location in Google Cloud Storage <https://cloud.google.com/storage/>__.

:type: str

VideoAnnotationResults

Annotation results for a single video. .. attribute:: input_uri

Video file location in Google Cloud Storage <https://cloud.google.com/storage/>__.

:type: str

VideoContext

Video context and/or feature-specific parameters. .. attribute:: 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.

:type: Sequence[google.cloud.videointelligence_v1p2beta1.types.VideoSegment]

VideoSegment

Video segment. .. attribute:: start_time_offset

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

:type: google.protobuf.duration_pb2.Duration