Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / datalabeling_v1beta1.projects.datasets.video.html
blob: c5fc8e278972f121157c632db8acc7ea4770e348 [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="datalabeling_v1beta1.html">Data Labeling API</a> . <a href="datalabeling_v1beta1.projects.html">projects</a> . <a href="datalabeling_v1beta1.projects.datasets.html">datasets</a> . <a href="datalabeling_v1beta1.projects.datasets.video.html">video</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#label">label(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Starts a labeling task for video. The type of video labeling task is configured by feature in the request.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90 <code class="details" id="label">label(parent, body=None, x__xgafv=None)</code>
91 <pre>Starts a labeling task for video. The type of video labeling task is configured by feature in the request.
92
93Args:
94 parent: string, Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id} (required)
95 body: object, The request body.
96 The object takes the form of:
97
98{ # Request message for LabelVideo.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]99 &quot;objectDetectionConfig&quot;: { # Config for video object detection human labeling task. Object detection will be conducted on the images extracted from the video, and those objects will be labeled with bounding boxes. User need to specify the number of images to be extracted per second as the extraction frame rate. # Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.
100 &quot;extractionFrameRate&quot;: 3.14, # Required. Number of frames per second to be extracted from the video.
101 &quot;annotationSpecSet&quot;: &quot;A String&quot;, # Required. Annotation spec set resource name.
102 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]103 &quot;basicConfig&quot;: { # Configuration for how human labeling task should be done. # Required. Basic human annotation config.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]104 &quot;replicaCount&quot;: 42, # Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]105 &quot;instruction&quot;: &quot;A String&quot;, # Required. Instruction resource name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]106 &quot;questionDuration&quot;: &quot;A String&quot;, # Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.
107 &quot;annotatedDatasetDescription&quot;: &quot;A String&quot;, # Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.
108 &quot;labelGroup&quot;: &quot;A String&quot;, # Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\d_-]{0,128}`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]109 &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.
110 &quot;userEmailAddress&quot;: &quot;A String&quot;, # Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.
111 &quot;annotatedDatasetDisplayName&quot;: &quot;A String&quot;, # Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]112 &quot;contributorEmails&quot;: [ # Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/
113 &quot;A String&quot;,
114 ],
115 },
116 &quot;objectTrackingConfig&quot;: { # Config for video object tracking human labeling task. # Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.
117 &quot;annotationSpecSet&quot;: &quot;A String&quot;, # Required. Annotation spec set resource name.
118 &quot;clipLength&quot;: 42, # Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 20s.
119 &quot;overlapLength&quot;: 42, # The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 0.3s.
120 },
121 &quot;videoClassificationConfig&quot;: { # Config for video classification human labeling task. Currently two types of video classification are supported: 1. Assign labels on the entire video. 2. Split the video into multiple video clips based on camera shot, and assign labels on each video clip. # Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.
122 &quot;annotationSpecSetConfigs&quot;: [ # Required. The list of annotation spec set configs. Since watching a video clip takes much longer time than an image, we support label with multiple AnnotationSpecSet at the same time. Labels in each AnnotationSpecSet will be shown in a group to contributors. Contributors can select one or more (depending on whether to allow multi label) from each group.
123 { # Annotation spec set with the setting of allowing multi labels or not.
124 &quot;annotationSpecSet&quot;: &quot;A String&quot;, # Required. Annotation spec set resource name.
125 &quot;allowMultiLabel&quot;: True or False, # Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set.
126 },
127 ],
128 &quot;applyShotDetection&quot;: True or False, # Optional. Option to apply shot detection on the video.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]129 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]130 &quot;eventConfig&quot;: { # Config for video event human labeling task. # Configuration for video event task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]131 &quot;clipLength&quot;: 42, # Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 60s.
132 &quot;overlapLength&quot;: 42, # The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]133 &quot;annotationSpecSets&quot;: [ # Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time.
134 &quot;A String&quot;,
135 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]136 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]137 &quot;feature&quot;: &quot;A String&quot;, # Required. The type of video labeling task.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]138 }
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]149 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]150 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]153 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
154 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
155 },
156 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]157 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
158 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
159 {
160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
161 },
162 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]163 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]164 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]165 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]166 }</pre>
167</div>
168
169</body></html>