API documentation for videointelligence_v1.types module.
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.
The video data bytes. If unset, the input video(s) should be
specified via input_uri. If set, input_uri should be
unset.
Additional video context and/or feature-specific parameters.
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.
Any
API documentation for videointelligence_v1.types.Any class.
CancelOperationRequest
API documentation for videointelligence_v1.types.CancelOperationRequest class.
DeleteOperationRequest
API documentation for videointelligence_v1.types.DeleteOperationRequest class.
Duration
API documentation for videointelligence_v1.types.Duration class.
Entity
Detected entity from video analysis.
Textual description, e.g. Fixed-gear bicycle.
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.
ExplicitContentFrame
Video frame level annotation results for explicit content.
Likelihood of the pornography content..
FaceAnnotation
Face annotation.
All video segments where a face was detected.
FaceDetectionConfig
Config for FACE_DETECTION.
Whether bounding boxes be included in the face annotation output.
FaceFrame
Video frame level annotation results for face detection.
Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
FaceSegment
Video segment level annotation results for face detection.
GetOperationRequest
API documentation for videointelligence_v1.types.GetOperationRequest class.
LabelAnnotation
Label annotation.
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 frames where a label was detected.
LabelDetectionConfig
Config for LABEL_DETECTION.
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.
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.
LabelFrame
Video frame level annotation results for label detection.
Confidence that the label is accurate. Range: [0, 1].
LabelSegment
Video segment level annotation results for label detection.
Confidence that the label is accurate. Range: [0, 1].
ListOperationsRequest
API documentation for videointelligence_v1.types.ListOperationsRequest class.
ListOperationsResponse
API documentation for videointelligence_v1.types.ListOperationsResponse class.
NormalizedBoundingBox
Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1].
Top Y coordinate.
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.
NormalizedVertex
X coordinate.
ObjectTrackingAnnotation
Annotations corresponding to one tracked object.
Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.
Entity to specify the object category that this track is labeled as.
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.
ObjectTrackingConfig
Config for OBJECT_TRACKING.
ObjectTrackingFrame
Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence.
The timestamp of the frame in microseconds.
Operation
API documentation for videointelligence_v1.types.Operation class.
OperationInfo
API documentation for videointelligence_v1.types.OperationInfo class.
ShotChangeDetectionConfig
Config for SHOT_CHANGE_DETECTION.
SpeechContext
Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
SpeechRecognitionAlternative
Alternative hypotheses (a.k.a. n-best list).
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.
SpeechTranscription
A speech recognition result corresponding to a portion of the audio.
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.
SpeechTranscriptionConfig
Config for SPEECH_TRANSCRIPTION.
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 A means to provide context to assist the speech recognition.
Optional For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.
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.
Status
API documentation for videointelligence_v1.types.Status class.
TextAnnotation
Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection.
All video segments where OCR detected text appears.
TextDetectionConfig
Config for TEXT_DETECTION.
Model to use for text detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest".
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.
Timestamp of this frame.
TextSegment
Video segment level annotation results for text detection.
Confidence for the track of detected text. It is calculated as the highest over all frames where OCR detected text appears.
Timestamp
API documentation for videointelligence_v1.types.Timestamp class.
VideoAnnotationProgress
Annotation progress for a single video.
Approximate percentage processed thus far. Guaranteed to be 100 when fully processed.
Time of the most recent update.
VideoAnnotationResults
Annotation results for a single video.
Label annotations on video level or user specified segment 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.
Speech transcription.
Annotations for list of objects detected and tracked in video.
VideoContext
Video context and/or feature-specific parameters.
Config for LABEL_DETECTION.
Config for EXPLICIT_CONTENT_DETECTION.
Config for SPEECH_TRANSCRIPTION.
Config for OBJECT_TRACKING.
VideoSegment
Video segment.
Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).
WaitOperationRequest
API documentation for videointelligence_v1.types.WaitOperationRequest class.
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.
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.
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.