google-cloud-video_intelligence-v1p1beta1 0.1.0 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +5 -1
- data/lib/google/cloud/video_intelligence/v1p1beta1.rb +1 -1
- data/lib/google/cloud/video_intelligence/v1p1beta1/version.rb +1 -1
- data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service.rb +1 -1
- data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/client.rb +68 -63
- data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/credentials.rb +1 -1
- data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/operations.rb +109 -103
- data/proto_docs/google/api/resource.rb +12 -12
- data/proto_docs/google/cloud/videointelligence/v1p1beta1/video_intelligence.rb +102 -102
- data/proto_docs/google/longrunning/operations.rb +30 -30
- data/proto_docs/google/protobuf/any.rb +4 -4
- data/proto_docs/google/protobuf/duration.rb +4 -4
- data/proto_docs/google/protobuf/empty.rb +2 -2
- data/proto_docs/google/protobuf/timestamp.rb +4 -4
- data/proto_docs/google/rpc/status.rb +6 -6
- metadata +33 -6
- data/lib/google/cloud/common_resources_pb.rb +0 -15
|
@@ -128,7 +128,7 @@ module Google
|
|
|
128
128
|
# - pattern: "shelves/{shelf}"
|
|
129
129
|
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
|
130
130
|
# @!attribute [rw] type
|
|
131
|
-
# @return [String]
|
|
131
|
+
# @return [::String]
|
|
132
132
|
# The resource type. It must be in the format of
|
|
133
133
|
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
|
134
134
|
# singular and must not include version numbers.
|
|
@@ -140,7 +140,7 @@ module Google
|
|
|
140
140
|
# should use PascalCase (UpperCamelCase). The maximum number of
|
|
141
141
|
# characters allowed for the `resource_type_kind` is 100.
|
|
142
142
|
# @!attribute [rw] pattern
|
|
143
|
-
# @return [Array
|
|
143
|
+
# @return [::Array<::String>]
|
|
144
144
|
# Optional. The relative resource name pattern associated with this resource
|
|
145
145
|
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
|
146
146
|
#
|
|
@@ -161,11 +161,11 @@ module Google
|
|
|
161
161
|
# the same component name (e.g. "project") refers to IDs of the same
|
|
162
162
|
# type of resource.
|
|
163
163
|
# @!attribute [rw] name_field
|
|
164
|
-
# @return [String]
|
|
164
|
+
# @return [::String]
|
|
165
165
|
# Optional. The field on the resource that designates the resource name
|
|
166
166
|
# field. If omitted, this is assumed to be "name".
|
|
167
167
|
# @!attribute [rw] history
|
|
168
|
-
# @return [Google::Api::ResourceDescriptor::History]
|
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
|
169
169
|
# Optional. The historical or future-looking state of the resource pattern.
|
|
170
170
|
#
|
|
171
171
|
# Example:
|
|
@@ -182,19 +182,19 @@ module Google
|
|
|
182
182
|
# };
|
|
183
183
|
# }
|
|
184
184
|
# @!attribute [rw] plural
|
|
185
|
-
# @return [String]
|
|
185
|
+
# @return [::String]
|
|
186
186
|
# The plural name used in the resource name, such as 'projects' for
|
|
187
187
|
# the name of 'projects/\\{project}'. It is the same concept of the `plural`
|
|
188
188
|
# field in k8s CRD spec
|
|
189
189
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
190
190
|
# @!attribute [rw] singular
|
|
191
|
-
# @return [String]
|
|
191
|
+
# @return [::String]
|
|
192
192
|
# The same concept of the `singular` field in k8s CRD spec
|
|
193
193
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
|
194
194
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
|
195
195
|
class ResourceDescriptor
|
|
196
|
-
include Google::Protobuf::MessageExts
|
|
197
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
196
|
+
include ::Google::Protobuf::MessageExts
|
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
198
198
|
|
|
199
199
|
# A description of the historical or future-looking state of the
|
|
200
200
|
# resource pattern.
|
|
@@ -216,7 +216,7 @@ module Google
|
|
|
216
216
|
# Defines a proto annotation that describes a string field that refers to
|
|
217
217
|
# an API resource.
|
|
218
218
|
# @!attribute [rw] type
|
|
219
|
-
# @return [String]
|
|
219
|
+
# @return [::String]
|
|
220
220
|
# The resource type that the annotated field references.
|
|
221
221
|
#
|
|
222
222
|
# Example:
|
|
@@ -227,7 +227,7 @@ module Google
|
|
|
227
227
|
# }];
|
|
228
228
|
# }
|
|
229
229
|
# @!attribute [rw] child_type
|
|
230
|
-
# @return [String]
|
|
230
|
+
# @return [::String]
|
|
231
231
|
# The resource type of a child collection that the annotated field
|
|
232
232
|
# references. This is useful for annotating the `parent` field that
|
|
233
233
|
# doesn't have a fixed resource type.
|
|
@@ -240,8 +240,8 @@ module Google
|
|
|
240
240
|
# };
|
|
241
241
|
# }
|
|
242
242
|
class ResourceReference
|
|
243
|
-
include Google::Protobuf::MessageExts
|
|
244
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
243
|
+
include ::Google::Protobuf::MessageExts
|
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
245
245
|
end
|
|
246
246
|
end
|
|
247
247
|
end
|
|
@@ -23,7 +23,7 @@ module Google
|
|
|
23
23
|
module V1p1beta1
|
|
24
24
|
# Video annotation request.
|
|
25
25
|
# @!attribute [rw] input_uri
|
|
26
|
-
# @return [String]
|
|
26
|
+
# @return [::String]
|
|
27
27
|
# Input video location. Currently, only
|
|
28
28
|
# [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
|
|
29
29
|
# supported, which must be specified in the following format:
|
|
@@ -35,18 +35,18 @@ module Google
|
|
|
35
35
|
# '?' to match 1 character. If unset, the input video should be embedded
|
|
36
36
|
# in the request as `input_content`. If set, `input_content` should be unset.
|
|
37
37
|
# @!attribute [rw] input_content
|
|
38
|
-
# @return [String]
|
|
38
|
+
# @return [::String]
|
|
39
39
|
# The video data bytes.
|
|
40
40
|
# If unset, the input video(s) should be specified via `input_uri`.
|
|
41
41
|
# If set, `input_uri` should be unset.
|
|
42
42
|
# @!attribute [rw] features
|
|
43
|
-
# @return [Array
|
|
43
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::Feature>]
|
|
44
44
|
# Required. Requested video annotation features.
|
|
45
45
|
# @!attribute [rw] video_context
|
|
46
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::VideoContext]
|
|
46
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::VideoContext]
|
|
47
47
|
# Additional video context and/or feature-specific parameters.
|
|
48
48
|
# @!attribute [rw] output_uri
|
|
49
|
-
# @return [String]
|
|
49
|
+
# @return [::String]
|
|
50
50
|
# Optional. Location where the output (in JSON format) should be stored.
|
|
51
51
|
# Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
|
|
52
52
|
# URIs are supported, which must be specified in the following format:
|
|
@@ -54,285 +54,285 @@ module Google
|
|
|
54
54
|
# [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see
|
|
55
55
|
# [Request URIs](https://cloud.google.com/storage/docs/request-endpoints).
|
|
56
56
|
# @!attribute [rw] location_id
|
|
57
|
-
# @return [String]
|
|
57
|
+
# @return [::String]
|
|
58
58
|
# Optional. Cloud region where annotation should take place. Supported cloud
|
|
59
59
|
# regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
|
|
60
60
|
# is specified, a region will be determined based on video file location.
|
|
61
61
|
class AnnotateVideoRequest
|
|
62
|
-
include Google::Protobuf::MessageExts
|
|
63
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
62
|
+
include ::Google::Protobuf::MessageExts
|
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
64
64
|
end
|
|
65
65
|
|
|
66
66
|
# Video context and/or feature-specific parameters.
|
|
67
67
|
# @!attribute [rw] segments
|
|
68
|
-
# @return [Array
|
|
68
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::VideoSegment>]
|
|
69
69
|
# Video segments to annotate. The segments may overlap and are not required
|
|
70
70
|
# to be contiguous or span the whole video. If unspecified, each video is
|
|
71
71
|
# treated as a single segment.
|
|
72
72
|
# @!attribute [rw] label_detection_config
|
|
73
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::LabelDetectionConfig]
|
|
73
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::LabelDetectionConfig]
|
|
74
74
|
# Config for LABEL_DETECTION.
|
|
75
75
|
# @!attribute [rw] shot_change_detection_config
|
|
76
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::ShotChangeDetectionConfig]
|
|
76
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::ShotChangeDetectionConfig]
|
|
77
77
|
# Config for SHOT_CHANGE_DETECTION.
|
|
78
78
|
# @!attribute [rw] explicit_content_detection_config
|
|
79
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::ExplicitContentDetectionConfig]
|
|
79
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::ExplicitContentDetectionConfig]
|
|
80
80
|
# Config for EXPLICIT_CONTENT_DETECTION.
|
|
81
81
|
# @!attribute [rw] speech_transcription_config
|
|
82
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::SpeechTranscriptionConfig]
|
|
82
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::SpeechTranscriptionConfig]
|
|
83
83
|
# Config for SPEECH_TRANSCRIPTION.
|
|
84
84
|
class VideoContext
|
|
85
|
-
include Google::Protobuf::MessageExts
|
|
86
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
85
|
+
include ::Google::Protobuf::MessageExts
|
|
86
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
87
87
|
end
|
|
88
88
|
|
|
89
89
|
# Config for LABEL_DETECTION.
|
|
90
90
|
# @!attribute [rw] label_detection_mode
|
|
91
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::LabelDetectionMode]
|
|
91
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::LabelDetectionMode]
|
|
92
92
|
# What labels should be detected with LABEL_DETECTION, in addition to
|
|
93
93
|
# video-level labels or segment-level labels.
|
|
94
94
|
# If unspecified, defaults to `SHOT_MODE`.
|
|
95
95
|
# @!attribute [rw] stationary_camera
|
|
96
|
-
# @return [Boolean]
|
|
96
|
+
# @return [::Boolean]
|
|
97
97
|
# Whether the video has been shot from a stationary (i.e. non-moving) camera.
|
|
98
98
|
# When set to true, might improve detection accuracy for moving objects.
|
|
99
99
|
# Should be used with `SHOT_AND_FRAME_MODE` enabled.
|
|
100
100
|
# @!attribute [rw] model
|
|
101
|
-
# @return [String]
|
|
101
|
+
# @return [::String]
|
|
102
102
|
# Model to use for label detection.
|
|
103
103
|
# Supported values: "builtin/stable" (the default if unset) and
|
|
104
104
|
# "builtin/latest".
|
|
105
105
|
class LabelDetectionConfig
|
|
106
|
-
include Google::Protobuf::MessageExts
|
|
107
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
106
|
+
include ::Google::Protobuf::MessageExts
|
|
107
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
108
108
|
end
|
|
109
109
|
|
|
110
110
|
# Config for SHOT_CHANGE_DETECTION.
|
|
111
111
|
# @!attribute [rw] model
|
|
112
|
-
# @return [String]
|
|
112
|
+
# @return [::String]
|
|
113
113
|
# Model to use for shot change detection.
|
|
114
114
|
# Supported values: "builtin/stable" (the default if unset) and
|
|
115
115
|
# "builtin/latest".
|
|
116
116
|
class ShotChangeDetectionConfig
|
|
117
|
-
include Google::Protobuf::MessageExts
|
|
118
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
117
|
+
include ::Google::Protobuf::MessageExts
|
|
118
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
119
119
|
end
|
|
120
120
|
|
|
121
121
|
# Config for EXPLICIT_CONTENT_DETECTION.
|
|
122
122
|
# @!attribute [rw] model
|
|
123
|
-
# @return [String]
|
|
123
|
+
# @return [::String]
|
|
124
124
|
# Model to use for explicit content detection.
|
|
125
125
|
# Supported values: "builtin/stable" (the default if unset) and
|
|
126
126
|
# "builtin/latest".
|
|
127
127
|
class ExplicitContentDetectionConfig
|
|
128
|
-
include Google::Protobuf::MessageExts
|
|
129
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
128
|
+
include ::Google::Protobuf::MessageExts
|
|
129
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
130
130
|
end
|
|
131
131
|
|
|
132
132
|
# Video segment.
|
|
133
133
|
# @!attribute [rw] start_time_offset
|
|
134
|
-
# @return [Google::Protobuf::Duration]
|
|
134
|
+
# @return [::Google::Protobuf::Duration]
|
|
135
135
|
# Time-offset, relative to the beginning of the video,
|
|
136
136
|
# corresponding to the start of the segment (inclusive).
|
|
137
137
|
# @!attribute [rw] end_time_offset
|
|
138
|
-
# @return [Google::Protobuf::Duration]
|
|
138
|
+
# @return [::Google::Protobuf::Duration]
|
|
139
139
|
# Time-offset, relative to the beginning of the video,
|
|
140
140
|
# corresponding to the end of the segment (inclusive).
|
|
141
141
|
class VideoSegment
|
|
142
|
-
include Google::Protobuf::MessageExts
|
|
143
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
142
|
+
include ::Google::Protobuf::MessageExts
|
|
143
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
144
144
|
end
|
|
145
145
|
|
|
146
146
|
# Video segment level annotation results for label detection.
|
|
147
147
|
# @!attribute [rw] segment
|
|
148
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::VideoSegment]
|
|
148
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::VideoSegment]
|
|
149
149
|
# Video segment where a label was detected.
|
|
150
150
|
# @!attribute [rw] confidence
|
|
151
|
-
# @return [Float]
|
|
151
|
+
# @return [::Float]
|
|
152
152
|
# Confidence that the label is accurate. Range: [0, 1].
|
|
153
153
|
class LabelSegment
|
|
154
|
-
include Google::Protobuf::MessageExts
|
|
155
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
154
|
+
include ::Google::Protobuf::MessageExts
|
|
155
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
156
156
|
end
|
|
157
157
|
|
|
158
158
|
# Video frame level annotation results for label detection.
|
|
159
159
|
# @!attribute [rw] time_offset
|
|
160
|
-
# @return [Google::Protobuf::Duration]
|
|
160
|
+
# @return [::Google::Protobuf::Duration]
|
|
161
161
|
# Time-offset, relative to the beginning of the video, corresponding to the
|
|
162
162
|
# video frame for this location.
|
|
163
163
|
# @!attribute [rw] confidence
|
|
164
|
-
# @return [Float]
|
|
164
|
+
# @return [::Float]
|
|
165
165
|
# Confidence that the label is accurate. Range: [0, 1].
|
|
166
166
|
class LabelFrame
|
|
167
|
-
include Google::Protobuf::MessageExts
|
|
168
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
167
|
+
include ::Google::Protobuf::MessageExts
|
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
169
169
|
end
|
|
170
170
|
|
|
171
171
|
# Detected entity from video analysis.
|
|
172
172
|
# @!attribute [rw] entity_id
|
|
173
|
-
# @return [String]
|
|
173
|
+
# @return [::String]
|
|
174
174
|
# Opaque entity ID. Some IDs may be available in
|
|
175
175
|
# [Google Knowledge Graph Search
|
|
176
176
|
# API](https://developers.google.com/knowledge-graph/).
|
|
177
177
|
# @!attribute [rw] description
|
|
178
|
-
# @return [String]
|
|
178
|
+
# @return [::String]
|
|
179
179
|
# Textual description, e.g. `Fixed-gear bicycle`.
|
|
180
180
|
# @!attribute [rw] language_code
|
|
181
|
-
# @return [String]
|
|
181
|
+
# @return [::String]
|
|
182
182
|
# Language code for `description` in BCP-47 format.
|
|
183
183
|
class Entity
|
|
184
|
-
include Google::Protobuf::MessageExts
|
|
185
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
184
|
+
include ::Google::Protobuf::MessageExts
|
|
185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
186
186
|
end
|
|
187
187
|
|
|
188
188
|
# Label annotation.
|
|
189
189
|
# @!attribute [rw] entity
|
|
190
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::Entity]
|
|
190
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::Entity]
|
|
191
191
|
# Detected entity.
|
|
192
192
|
# @!attribute [rw] category_entities
|
|
193
|
-
# @return [Array
|
|
193
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::Entity>]
|
|
194
194
|
# Common categories for the detected entity.
|
|
195
195
|
# E.g. when the label is `Terrier` the category is likely `dog`. And in some
|
|
196
196
|
# cases there might be more than one categories e.g. `Terrier` could also be
|
|
197
197
|
# a `pet`.
|
|
198
198
|
# @!attribute [rw] segments
|
|
199
|
-
# @return [Array
|
|
199
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::LabelSegment>]
|
|
200
200
|
# All video segments where a label was detected.
|
|
201
201
|
# @!attribute [rw] frames
|
|
202
|
-
# @return [Array
|
|
202
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::LabelFrame>]
|
|
203
203
|
# All video frames where a label was detected.
|
|
204
204
|
class LabelAnnotation
|
|
205
|
-
include Google::Protobuf::MessageExts
|
|
206
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
205
|
+
include ::Google::Protobuf::MessageExts
|
|
206
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
207
207
|
end
|
|
208
208
|
|
|
209
209
|
# Video frame level annotation results for explicit content.
|
|
210
210
|
# @!attribute [rw] time_offset
|
|
211
|
-
# @return [Google::Protobuf::Duration]
|
|
211
|
+
# @return [::Google::Protobuf::Duration]
|
|
212
212
|
# Time-offset, relative to the beginning of the video, corresponding to the
|
|
213
213
|
# video frame for this location.
|
|
214
214
|
# @!attribute [rw] pornography_likelihood
|
|
215
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::Likelihood]
|
|
215
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::Likelihood]
|
|
216
216
|
# Likelihood of the pornography content..
|
|
217
217
|
class ExplicitContentFrame
|
|
218
|
-
include Google::Protobuf::MessageExts
|
|
219
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
218
|
+
include ::Google::Protobuf::MessageExts
|
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
220
220
|
end
|
|
221
221
|
|
|
222
222
|
# Explicit content annotation (based on per-frame visual signals only).
|
|
223
223
|
# If no explicit content has been detected in a frame, no annotations are
|
|
224
224
|
# present for that frame.
|
|
225
225
|
# @!attribute [rw] frames
|
|
226
|
-
# @return [Array
|
|
226
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::ExplicitContentFrame>]
|
|
227
227
|
# All video frames where explicit content was detected.
|
|
228
228
|
class ExplicitContentAnnotation
|
|
229
|
-
include Google::Protobuf::MessageExts
|
|
230
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
229
|
+
include ::Google::Protobuf::MessageExts
|
|
230
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
231
231
|
end
|
|
232
232
|
|
|
233
233
|
# Annotation results for a single video.
|
|
234
234
|
# @!attribute [rw] input_uri
|
|
235
|
-
# @return [String]
|
|
235
|
+
# @return [::String]
|
|
236
236
|
# Output only. Video file location in
|
|
237
237
|
# [Google Cloud Storage](https://cloud.google.com/storage/).
|
|
238
238
|
# @!attribute [rw] segment_label_annotations
|
|
239
|
-
# @return [Array
|
|
239
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::LabelAnnotation>]
|
|
240
240
|
# Label annotations on video level or user specified segment level.
|
|
241
241
|
# There is exactly one element for each unique label.
|
|
242
242
|
# @!attribute [rw] shot_label_annotations
|
|
243
|
-
# @return [Array
|
|
243
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::LabelAnnotation>]
|
|
244
244
|
# Label annotations on shot level.
|
|
245
245
|
# There is exactly one element for each unique label.
|
|
246
246
|
# @!attribute [rw] frame_label_annotations
|
|
247
|
-
# @return [Array
|
|
247
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::LabelAnnotation>]
|
|
248
248
|
# Label annotations on frame level.
|
|
249
249
|
# There is exactly one element for each unique label.
|
|
250
250
|
# @!attribute [rw] shot_annotations
|
|
251
|
-
# @return [Array
|
|
251
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::VideoSegment>]
|
|
252
252
|
# Shot annotations. Each shot is represented as a video segment.
|
|
253
253
|
# @!attribute [rw] explicit_annotation
|
|
254
|
-
# @return [Google::Cloud::VideoIntelligence::V1p1beta1::ExplicitContentAnnotation]
|
|
254
|
+
# @return [::Google::Cloud::VideoIntelligence::V1p1beta1::ExplicitContentAnnotation]
|
|
255
255
|
# Explicit content annotation.
|
|
256
256
|
# @!attribute [rw] speech_transcriptions
|
|
257
|
-
# @return [Array
|
|
257
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::SpeechTranscription>]
|
|
258
258
|
# Speech transcription.
|
|
259
259
|
# @!attribute [rw] error
|
|
260
|
-
# @return [Google::Rpc::Status]
|
|
260
|
+
# @return [::Google::Rpc::Status]
|
|
261
261
|
# Output only. If set, indicates an error. Note that for a single
|
|
262
262
|
# `AnnotateVideoRequest` some videos may succeed and some may fail.
|
|
263
263
|
class VideoAnnotationResults
|
|
264
|
-
include Google::Protobuf::MessageExts
|
|
265
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
264
|
+
include ::Google::Protobuf::MessageExts
|
|
265
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
266
266
|
end
|
|
267
267
|
|
|
268
268
|
# Video annotation response. Included in the `response`
|
|
269
269
|
# field of the `Operation` returned by the `GetOperation`
|
|
270
270
|
# call of the `google::longrunning::Operations` service.
|
|
271
271
|
# @!attribute [rw] annotation_results
|
|
272
|
-
# @return [Array
|
|
272
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::VideoAnnotationResults>]
|
|
273
273
|
# Annotation results for all videos specified in `AnnotateVideoRequest`.
|
|
274
274
|
class AnnotateVideoResponse
|
|
275
|
-
include Google::Protobuf::MessageExts
|
|
276
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
275
|
+
include ::Google::Protobuf::MessageExts
|
|
276
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
277
277
|
end
|
|
278
278
|
|
|
279
279
|
# Annotation progress for a single video.
|
|
280
280
|
# @!attribute [rw] input_uri
|
|
281
|
-
# @return [String]
|
|
281
|
+
# @return [::String]
|
|
282
282
|
# Output only. Video file location in
|
|
283
283
|
# [Google Cloud Storage](https://cloud.google.com/storage/).
|
|
284
284
|
# @!attribute [rw] progress_percent
|
|
285
|
-
# @return [Integer]
|
|
285
|
+
# @return [::Integer]
|
|
286
286
|
# Output only. Approximate percentage processed thus far. Guaranteed to be
|
|
287
287
|
# 100 when fully processed.
|
|
288
288
|
# @!attribute [rw] start_time
|
|
289
|
-
# @return [Google::Protobuf::Timestamp]
|
|
289
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
290
290
|
# Output only. Time when the request was received.
|
|
291
291
|
# @!attribute [rw] update_time
|
|
292
|
-
# @return [Google::Protobuf::Timestamp]
|
|
292
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
293
293
|
# Output only. Time of the most recent update.
|
|
294
294
|
class VideoAnnotationProgress
|
|
295
|
-
include Google::Protobuf::MessageExts
|
|
296
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
295
|
+
include ::Google::Protobuf::MessageExts
|
|
296
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
297
297
|
end
|
|
298
298
|
|
|
299
299
|
# Video annotation progress. Included in the `metadata`
|
|
300
300
|
# field of the `Operation` returned by the `GetOperation`
|
|
301
301
|
# call of the `google::longrunning::Operations` service.
|
|
302
302
|
# @!attribute [rw] annotation_progress
|
|
303
|
-
# @return [Array
|
|
303
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::VideoAnnotationProgress>]
|
|
304
304
|
# Progress metadata for all videos specified in `AnnotateVideoRequest`.
|
|
305
305
|
class AnnotateVideoProgress
|
|
306
|
-
include Google::Protobuf::MessageExts
|
|
307
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
306
|
+
include ::Google::Protobuf::MessageExts
|
|
307
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
308
308
|
end
|
|
309
309
|
|
|
310
310
|
# Config for SPEECH_TRANSCRIPTION.
|
|
311
311
|
# @!attribute [rw] language_code
|
|
312
|
-
# @return [String]
|
|
312
|
+
# @return [::String]
|
|
313
313
|
# Required. *Required* The language of the supplied audio as a
|
|
314
314
|
# [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
|
|
315
315
|
# Example: "en-US".
|
|
316
316
|
# See [Language Support](https://cloud.google.com/speech/docs/languages)
|
|
317
317
|
# for a list of the currently supported language codes.
|
|
318
318
|
# @!attribute [rw] max_alternatives
|
|
319
|
-
# @return [Integer]
|
|
319
|
+
# @return [::Integer]
|
|
320
320
|
# Optional. Maximum number of recognition hypotheses to be returned.
|
|
321
321
|
# Specifically, the maximum number of `SpeechRecognitionAlternative` messages
|
|
322
322
|
# within each `SpeechTranscription`. The server may return fewer than
|
|
323
323
|
# `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will
|
|
324
324
|
# return a maximum of one. If omitted, will return a maximum of one.
|
|
325
325
|
# @!attribute [rw] filter_profanity
|
|
326
|
-
# @return [Boolean]
|
|
326
|
+
# @return [::Boolean]
|
|
327
327
|
# Optional. If set to `true`, the server will attempt to filter out
|
|
328
328
|
# profanities, replacing all but the initial character in each filtered word
|
|
329
329
|
# with asterisks, e.g. "f***". If set to `false` or omitted, profanities
|
|
330
330
|
# won't be filtered out.
|
|
331
331
|
# @!attribute [rw] speech_contexts
|
|
332
|
-
# @return [Array
|
|
332
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::SpeechContext>]
|
|
333
333
|
# Optional. A means to provide context to assist the speech recognition.
|
|
334
334
|
# @!attribute [rw] enable_automatic_punctuation
|
|
335
|
-
# @return [Boolean]
|
|
335
|
+
# @return [::Boolean]
|
|
336
336
|
# Optional. If 'true', adds punctuation to recognition result hypotheses.
|
|
337
337
|
# This feature is only available in select languages. Setting this for
|
|
338
338
|
# requests in other languages has no effect at all. The default 'false' value
|
|
@@ -340,18 +340,18 @@ module Google
|
|
|
340
340
|
# offered as an experimental service, complimentary to all users. In the
|
|
341
341
|
# future this may be exclusively available as a premium feature."
|
|
342
342
|
# @!attribute [rw] audio_tracks
|
|
343
|
-
# @return [Array
|
|
343
|
+
# @return [::Array<::Integer>]
|
|
344
344
|
# Optional. For file formats, such as MXF or MKV, supporting multiple audio
|
|
345
345
|
# tracks, specify up to two tracks. Default: track 0.
|
|
346
346
|
class SpeechTranscriptionConfig
|
|
347
|
-
include Google::Protobuf::MessageExts
|
|
348
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
347
|
+
include ::Google::Protobuf::MessageExts
|
|
348
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
349
349
|
end
|
|
350
350
|
|
|
351
351
|
# Provides "hints" to the speech recognizer to favor specific words and phrases
|
|
352
352
|
# in the results.
|
|
353
353
|
# @!attribute [rw] phrases
|
|
354
|
-
# @return [Array
|
|
354
|
+
# @return [::Array<::String>]
|
|
355
355
|
# Optional. A list of strings containing words and phrases "hints" so that
|
|
356
356
|
# the speech recognition is more likely to recognize them. This can be used
|
|
357
357
|
# to improve the accuracy for specific words and phrases, for example, if
|
|
@@ -359,28 +359,28 @@ module Google
|
|
|
359
359
|
# to add additional words to the vocabulary of the recognizer. See
|
|
360
360
|
# [usage limits](https://cloud.google.com/speech/limits#content).
|
|
361
361
|
class SpeechContext
|
|
362
|
-
include Google::Protobuf::MessageExts
|
|
363
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
362
|
+
include ::Google::Protobuf::MessageExts
|
|
363
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
364
364
|
end
|
|
365
365
|
|
|
366
366
|
# A speech recognition result corresponding to a portion of the audio.
|
|
367
367
|
# @!attribute [rw] alternatives
|
|
368
|
-
# @return [Array
|
|
368
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::SpeechRecognitionAlternative>]
|
|
369
369
|
# May contain one or more recognition hypotheses (up to the maximum specified
|
|
370
370
|
# in `max_alternatives`). These alternatives are ordered in terms of
|
|
371
371
|
# accuracy, with the top (first) alternative being the most probable, as
|
|
372
372
|
# ranked by the recognizer.
|
|
373
373
|
class SpeechTranscription
|
|
374
|
-
include Google::Protobuf::MessageExts
|
|
375
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
374
|
+
include ::Google::Protobuf::MessageExts
|
|
375
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
376
376
|
end
|
|
377
377
|
|
|
378
378
|
# Alternative hypotheses (a.k.a. n-best list).
|
|
379
379
|
# @!attribute [rw] transcript
|
|
380
|
-
# @return [String]
|
|
380
|
+
# @return [::String]
|
|
381
381
|
# Output only. Transcript text representing the words that the user spoke.
|
|
382
382
|
# @!attribute [r] confidence
|
|
383
|
-
# @return [Float]
|
|
383
|
+
# @return [::Float]
|
|
384
384
|
# Output only. The confidence estimate between 0.0 and 1.0. A higher number
|
|
385
385
|
# indicates an estimated greater likelihood that the recognized words are
|
|
386
386
|
# correct. This field is set only for the top alternative.
|
|
@@ -388,34 +388,34 @@ module Google
|
|
|
388
388
|
# to be always provided.
|
|
389
389
|
# The default of 0.0 is a sentinel value indicating `confidence` was not set.
|
|
390
390
|
# @!attribute [rw] words
|
|
391
|
-
# @return [Array
|
|
391
|
+
# @return [::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::WordInfo>]
|
|
392
392
|
# Output only. A list of word-specific information for each recognized word.
|
|
393
393
|
class SpeechRecognitionAlternative
|
|
394
|
-
include Google::Protobuf::MessageExts
|
|
395
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
394
|
+
include ::Google::Protobuf::MessageExts
|
|
395
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
396
396
|
end
|
|
397
397
|
|
|
398
398
|
# Word-specific information for recognized words. Word information is only
|
|
399
399
|
# included in the response when certain request parameters are set, such
|
|
400
400
|
# as `enable_word_time_offsets`.
|
|
401
401
|
# @!attribute [rw] start_time
|
|
402
|
-
# @return [Google::Protobuf::Duration]
|
|
402
|
+
# @return [::Google::Protobuf::Duration]
|
|
403
403
|
# Output only. Time offset relative to the beginning of the audio, and
|
|
404
404
|
# corresponding to the start of the spoken word. This field is only set if
|
|
405
405
|
# `enable_word_time_offsets=true` and only in the top hypothesis. This is an
|
|
406
406
|
# experimental feature and the accuracy of the time offset can vary.
|
|
407
407
|
# @!attribute [rw] end_time
|
|
408
|
-
# @return [Google::Protobuf::Duration]
|
|
408
|
+
# @return [::Google::Protobuf::Duration]
|
|
409
409
|
# Output only. Time offset relative to the beginning of the audio, and
|
|
410
410
|
# corresponding to the end of the spoken word. This field is only set if
|
|
411
411
|
# `enable_word_time_offsets=true` and only in the top hypothesis. This is an
|
|
412
412
|
# experimental feature and the accuracy of the time offset can vary.
|
|
413
413
|
# @!attribute [rw] word
|
|
414
|
-
# @return [String]
|
|
414
|
+
# @return [::String]
|
|
415
415
|
# Output only. The word corresponding to this set of information.
|
|
416
416
|
class WordInfo
|
|
417
|
-
include Google::Protobuf::MessageExts
|
|
418
|
-
extend Google::Protobuf::MessageExts::ClassMethods
|
|
417
|
+
include ::Google::Protobuf::MessageExts
|
|
418
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
419
419
|
end
|
|
420
420
|
|
|
421
421
|
# Video annotation feature.
|