| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | |
| 93 | Args: |
| 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. |
| 99 | "videoClassificationConfig": { # 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. |
| 100 | "applyShotDetection": True or False, # Optional. Option to apply shot detection on the video. |
| 101 | "annotationSpecSetConfigs": [ # 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. |
| 102 | { # Annotation spec set with the setting of allowing multi labels or not. |
| 103 | "allowMultiLabel": True or False, # Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set. |
| 104 | "annotationSpecSet": "A String", # Required. Annotation spec set resource name. |
| 105 | }, |
| 106 | ], |
| 107 | }, |
| 108 | "basicConfig": { # Configuration for how human labeling task should be done. # Required. Basic human annotation config. |
| 109 | "questionDuration": "A String", # Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds. |
| 110 | "annotatedDatasetDisplayName": "A String", # Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters . |
| 111 | "labelGroup": "A String", # Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\d_-]{0,128}`. |
| 112 | "userEmailAddress": "A String", # Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent. |
| 113 | "contributorEmails": [ # 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/ |
| 114 | "A String", |
| 115 | ], |
| 116 | "annotatedDatasetDescription": "A String", # Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long. |
| 117 | "languageCode": "A String", # 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. |
| 118 | "replicaCount": 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. |
| 119 | "instruction": "A String", # Required. Instruction resource name. |
| 120 | }, |
| 121 | "objectDetectionConfig": { # 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. |
| 122 | "annotationSpecSet": "A String", # Required. Annotation spec set resource name. |
| 123 | "extractionFrameRate": 3.14, # Required. Number of frames per second to be extracted from the video. |
| 124 | }, |
| 125 | "objectTrackingConfig": { # 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. |
| 126 | "clipLength": 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. |
| 127 | "annotationSpecSet": "A String", # Required. Annotation spec set resource name. |
| 128 | "overlapLength": 42, # The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 0.3s. |
| 129 | }, |
| 130 | "feature": "A String", # Required. The type of video labeling task. |
| 131 | "eventConfig": { # 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. |
| 132 | "annotationSpecSets": [ # Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time. |
| 133 | "A String", |
| 134 | ], |
| 135 | "clipLength": 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. |
| 136 | "overlapLength": 42, # The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s. |
| 137 | }, |
| 138 | } |
| 139 | |
| 140 | x__xgafv: string, V1 error format. |
| 141 | Allowed values |
| 142 | 1 - v1 error format |
| 143 | 2 - v2 error format |
| 144 | |
| 145 | Returns: |
| 146 | An object of the form: |
| 147 | |
| 148 | { # This resource represents a long-running operation that is the result of a network API call. |
| 149 | "name": "A String", # 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}`. |
| 150 | "done": 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. |
| 151 | "response": { # 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`. |
| 152 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 153 | }, |
| 154 | "metadata": { # 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. |
| 155 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 156 | }, |
| 157 | "error": { # 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 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 159 | { |
| 160 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 161 | }, |
| 162 | ], |
| 163 | "message": "A String", # 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. |
| 164 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 165 | }, |
| 166 | }</pre> |
| 167 | </div> |
| 168 | |
| 169 | </body></html> |