Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 32d1c597b364e2641eca33ccf6df802bb218eea1 / . / docs / dyn / datalabeling_v1beta1.projects.annotationSpecSets.html
blob: 2b6c380bff1df2e7779bd560855416d6c5287f48 [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.annotationSpecSets.html">annotationSpecSets</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates an annotation spec set by providing a set of labels.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes an annotation spec set by resource name.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets an annotation spec set by resource name.</p>
89<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]90 <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]91<p class="firstline">Lists annotation spec sets for a project. Pagination is supported.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
103 <pre>Creates an annotation spec set by providing a set of labels.
104
105Args:
106 parent: string, Required. AnnotationSpecSet resource parent, format: projects/{project_id} (required)
107 body: object, The request body.
108 The object takes the form of:
109
110{ # Request message for CreateAnnotationSpecSet.
111 &quot;annotationSpecSet&quot;: { # An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation. # Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]112 &quot;name&quot;: &quot;A String&quot;, # Output only. The AnnotationSpecSet resource name in the following format: &quot;projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}&quot;
113 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]114 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
115 &quot;A String&quot;,
116 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]117 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]118 &quot;annotationSpecs&quot;: [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
119 { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]120 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121 &quot;index&quot;: 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: &quot;dog&quot;, index: 0 }` and one AnnotationSpec with `{ display_name: &quot;cat&quot;, index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]122 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]123 },
124 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]125 },
126 }
127
128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]137 &quot;name&quot;: &quot;A String&quot;, # Output only. The AnnotationSpecSet resource name in the following format: &quot;projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}&quot;
138 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]139 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
140 &quot;A String&quot;,
141 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]142 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]143 &quot;annotationSpecs&quot;: [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
144 { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]145 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]146 &quot;index&quot;: 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: &quot;dog&quot;, index: 0 }` and one AnnotationSpec with `{ display_name: &quot;cat&quot;, index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]147 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]148 },
149 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 }</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
155 <pre>Deletes an annotation spec set by resource name.
156
157Args:
158 name: string, Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`. (required)
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
168 }</pre>
169</div>
170
171<div class="method">
172 <code class="details" id="get">get(name, x__xgafv=None)</code>
173 <pre>Gets an annotation spec set by resource name.
174
175Args:
176 name: string, Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id} (required)
177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182Returns:
183 An object of the form:
184
185 { # An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]186 &quot;name&quot;: &quot;A String&quot;, # Output only. The AnnotationSpecSet resource name in the following format: &quot;projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}&quot;
187 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]188 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
189 &quot;A String&quot;,
190 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]191 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]192 &quot;annotationSpecs&quot;: [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
193 { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]194 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]195 &quot;index&quot;: 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: &quot;dog&quot;, index: 0 }` and one AnnotationSpec with `{ display_name: &quot;cat&quot;, index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]196 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]197 },
198 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]199 }</pre>
200</div>
201
202<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]203 <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]204 <pre>Lists annotation spec sets for a project. Pagination is supported.
205
206Args:
207 parent: string, Required. Parent of AnnotationSpecSet resource, format: projects/{project_id} (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]208 pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]209 filter: string, Optional. Filter is not supported at this moment.
210 pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]211 x__xgafv: string, V1 error format.
212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
215
216Returns:
217 An object of the form:
218
219 { # Results of listing annotation spec set under a project.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]220 &quot;annotationSpecSets&quot;: [ # The list of annotation spec sets.
221 { # An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]222 &quot;name&quot;: &quot;A String&quot;, # Output only. The AnnotationSpecSet resource name in the following format: &quot;projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}&quot;
223 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]224 &quot;blockingResources&quot;: [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
225 &quot;A String&quot;,
226 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]227 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]228 &quot;annotationSpecs&quot;: [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
229 { # Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]230 &quot;description&quot;: &quot;A String&quot;, # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]231 &quot;index&quot;: 42, # Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: &quot;dog&quot;, index: 0 }` and one AnnotationSpec with `{ display_name: &quot;cat&quot;, index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]232 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]233 },
234 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]235 },
236 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]237 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve next page of results.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
250 A request object that you can call &#x27;execute()&#x27; on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255</body></html>