Types for Google Cloud Video Intelligence API Client

class google.cloud.videointelligence_v1beta1.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.v1beta1.AnnotateVideoProgress.annotation_progress

class google.cloud.videointelligence_v1beta1.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. Encoding: base64. 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.v1beta1.AnnotateVideoRequest.features

input_content

Field google.cloud.videointelligence.v1beta1.AnnotateVideoRequest.input_content

input_uri

Field google.cloud.videointelligence.v1beta1.AnnotateVideoRequest.input_uri

location_id

Field google.cloud.videointelligence.v1beta1.AnnotateVideoRequest.location_id

output_uri

Field google.cloud.videointelligence.v1beta1.AnnotateVideoRequest.output_uri

video_context

Field google.cloud.videointelligence.v1beta1.AnnotateVideoRequest.video_context

class google.cloud.videointelligence_v1beta1.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.v1beta1.AnnotateVideoResponse.annotation_results

class google.cloud.videointelligence_v1beta1.types.Any

type_url

Field google.protobuf.Any.type_url

value

Field google.protobuf.Any.value

class google.cloud.videointelligence_v1beta1.types.BoundingBox

Bounding box.

left

Left X coordinate.

right

Right X coordinate.

bottom

Bottom Y coordinate.

top

Top Y coordinate.

bottom

Field google.cloud.videointelligence.v1beta1.BoundingBox.bottom

left

Field google.cloud.videointelligence.v1beta1.BoundingBox.left

right

Field google.cloud.videointelligence.v1beta1.BoundingBox.right

top

Field google.cloud.videointelligence.v1beta1.BoundingBox.top

class google.cloud.videointelligence_v1beta1.types.CancelOperationRequest

name

Field google.longrunning.CancelOperationRequest.name

class google.cloud.videointelligence_v1beta1.types.DeleteOperationRequest

name

Field google.longrunning.DeleteOperationRequest.name

class google.cloud.videointelligence_v1beta1.types.FaceAnnotation

Face annotation.

thumbnail

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

segments

All locations where a face was detected. Faces are detected and tracked on a per-video basis (as opposed to across multiple videos).

locations

Face locations at one frame per second.

locations

Field google.cloud.videointelligence.v1beta1.FaceAnnotation.locations

segments

Field google.cloud.videointelligence.v1beta1.FaceAnnotation.segments

thumbnail

Field google.cloud.videointelligence.v1beta1.FaceAnnotation.thumbnail

class google.cloud.videointelligence_v1beta1.types.FaceLocation

Face location.

bounding_box

Bounding box in a frame.

time_offset

Video time offset in microseconds.

bounding_box

Field google.cloud.videointelligence.v1beta1.FaceLocation.bounding_box

time_offset

Field google.cloud.videointelligence.v1beta1.FaceLocation.time_offset

class google.cloud.videointelligence_v1beta1.types.GetOperationRequest

name

Field google.longrunning.GetOperationRequest.name

class google.cloud.videointelligence_v1beta1.types.LabelAnnotation

Label annotation.

description

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

language_code

Language code for description in BCP-47 format.

locations

Where the label was detected and with what confidence.

description

Field google.cloud.videointelligence.v1beta1.LabelAnnotation.description

language_code

Field google.cloud.videointelligence.v1beta1.LabelAnnotation.language_code

locations

Field google.cloud.videointelligence.v1beta1.LabelAnnotation.locations

class google.cloud.videointelligence_v1beta1.types.LabelLocation

Label location.

segment

Video segment. Set to [-1, -1] for video-level labels. Set to [timestamp, timestamp] for frame-level labels. Otherwise, corresponds to one of AnnotateSpec.segments (if specified) or to shot boundaries (if requested).

confidence

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

level

Label level.

confidence

Field google.cloud.videointelligence.v1beta1.LabelLocation.confidence

level

Field google.cloud.videointelligence.v1beta1.LabelLocation.level

segment

Field google.cloud.videointelligence.v1beta1.LabelLocation.segment

class google.cloud.videointelligence_v1beta1.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_v1beta1.types.ListOperationsResponse

next_page_token

Field google.longrunning.ListOperationsResponse.next_page_token

operations

Field google.longrunning.ListOperationsResponse.operations

class google.cloud.videointelligence_v1beta1.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_v1beta1.types.OperationInfo

metadata_type

Field google.longrunning.OperationInfo.metadata_type

response_type

Field google.longrunning.OperationInfo.response_type

class google.cloud.videointelligence_v1beta1.types.SafeSearchAnnotation

Safe search annotation (based on per-frame visual signals only). If no unsafe content has been detected in a frame, no annotations are present for that frame. If only some types of unsafe content have been detected in a frame, the likelihood is set to UNKNOWN for all other types of unsafe content.

adult

Likelihood of adult content.

spoof

Likelihood that an obvious modification was made to the original version to make it appear funny or offensive.

medical

Likelihood of medical content.

violent

Likelihood of violent content.

racy

Likelihood of racy content.

time_offset

Video time offset in microseconds.

adult

Field google.cloud.videointelligence.v1beta1.SafeSearchAnnotation.adult

medical

Field google.cloud.videointelligence.v1beta1.SafeSearchAnnotation.medical

racy

Field google.cloud.videointelligence.v1beta1.SafeSearchAnnotation.racy

spoof

Field google.cloud.videointelligence.v1beta1.SafeSearchAnnotation.spoof

time_offset

Field google.cloud.videointelligence.v1beta1.SafeSearchAnnotation.time_offset

violent

Field google.cloud.videointelligence.v1beta1.SafeSearchAnnotation.violent

class google.cloud.videointelligence_v1beta1.types.Status

code

Field google.rpc.Status.code

details

Field google.rpc.Status.details

message

Field google.rpc.Status.message

class google.cloud.videointelligence_v1beta1.types.Timestamp

nanos

Field google.protobuf.Timestamp.nanos

seconds

Field google.protobuf.Timestamp.seconds

class google.cloud.videointelligence_v1beta1.types.VideoAnnotationProgress

Annotation progress for a single video.

input_uri

Video file location in Google Cloud Storage.

progress_percent

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

start_time

Time when the request was received.

update_time

Time of the most recent update.

input_uri

Field google.cloud.videointelligence.v1beta1.VideoAnnotationProgress.input_uri

progress_percent

Field google.cloud.videointelligence.v1beta1.VideoAnnotationProgress.progress_percent

start_time

Field google.cloud.videointelligence.v1beta1.VideoAnnotationProgress.start_time

update_time

Field google.cloud.videointelligence.v1beta1.VideoAnnotationProgress.update_time

class google.cloud.videointelligence_v1beta1.types.VideoAnnotationResults

Annotation results for a single video.

input_uri

Video file location in Google Cloud Storage.

label_annotations

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

face_annotations

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

shot_annotations

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

safe_search_annotations

Safe search annotations.

error

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

error

Field google.cloud.videointelligence.v1beta1.VideoAnnotationResults.error

face_annotations

Field google.cloud.videointelligence.v1beta1.VideoAnnotationResults.face_annotations

input_uri

Field google.cloud.videointelligence.v1beta1.VideoAnnotationResults.input_uri

label_annotations

Field google.cloud.videointelligence.v1beta1.VideoAnnotationResults.label_annotations

safe_search_annotations

Field google.cloud.videointelligence.v1beta1.VideoAnnotationResults.safe_search_annotations

shot_annotations

Field google.cloud.videointelligence.v1beta1.VideoAnnotationResults.shot_annotations

class google.cloud.videointelligence_v1beta1.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_mode

If label detection has been requested, what labels should be detected 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.

label_detection_model

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

face_detection_model

Model to use for face detection. Supported values: “latest” and “stable” (the default).

shot_change_detection_model

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

safe_search_detection_model

Model to use for safe search detection. Supported values: “latest” and “stable” (the default).

face_detection_model

Field google.cloud.videointelligence.v1beta1.VideoContext.face_detection_model

label_detection_mode

Field google.cloud.videointelligence.v1beta1.VideoContext.label_detection_mode

label_detection_model

Field google.cloud.videointelligence.v1beta1.VideoContext.label_detection_model

safe_search_detection_model

Field google.cloud.videointelligence.v1beta1.VideoContext.safe_search_detection_model

segments

Field google.cloud.videointelligence.v1beta1.VideoContext.segments

shot_change_detection_model

Field google.cloud.videointelligence.v1beta1.VideoContext.shot_change_detection_model

stationary_camera

Field google.cloud.videointelligence.v1beta1.VideoContext.stationary_camera

class google.cloud.videointelligence_v1beta1.types.VideoSegment

Video segment.

start_time_offset

Start offset in microseconds (inclusive). Unset means 0.

end_time_offset

End offset in microseconds (inclusive). Unset means 0.

end_time_offset

Field google.cloud.videointelligence.v1beta1.VideoSegment.end_time_offset

start_time_offset

Field google.cloud.videointelligence.v1beta1.VideoSegment.start_time_offset