chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/datalabeling_v1beta1.projects.annotationSpecSets.html b/docs/dyn/datalabeling_v1beta1.projects.annotationSpecSets.html
index 2b6c380..000fcb5 100644
--- a/docs/dyn/datalabeling_v1beta1.projects.annotationSpecSets.html
+++ b/docs/dyn/datalabeling_v1beta1.projects.annotationSpecSets.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an annotation spec set by resource name.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists annotation spec sets for a project. Pagination is supported.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -108,22 +108,22 @@
The object takes the form of:
{ # Request message for CreateAnnotationSpecSet.
- "annotationSpecSet": { # 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.
- "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
- "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
- "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
- "A String",
- ],
- "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
- "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
- { # 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`.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- },
- ],
- },
- }
+ "annotationSpecSet": { # 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.
+ "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
+ { # 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`.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ ],
+ "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
+ "A String",
+ ],
+ "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
+ "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
+ },
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -134,20 +134,20 @@
An object of the form:
{ # 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.
- "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
- "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
- "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
- "A String",
- ],
- "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
- "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
- { # 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`.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- },
- ],
- }</pre>
+ "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
+ { # 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`.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ ],
+ "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
+ "A String",
+ ],
+ "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
+ "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
+}</pre>
</div>
<div class="method">
@@ -165,7 +165,7 @@
An object of the form:
{ # 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 `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -183,31 +183,31 @@
An object of the form:
{ # 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.
- "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
- "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
- "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
- "A String",
- ],
- "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
- "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
- { # 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`.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- },
- ],
- }</pre>
+ "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
+ { # 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`.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ ],
+ "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
+ "A String",
+ ],
+ "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
+ "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
+}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists annotation spec sets for a project. Pagination is supported.
Args:
parent: string, Required. Parent of AnnotationSpecSet resource, format: projects/{project_id} (required)
- 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.
filter: string, Optional. Filter is not supported at this moment.
pageSize: integer, Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -217,25 +217,25 @@
An object of the form:
{ # Results of listing annotation spec set under a project.
- "annotationSpecSets": [ # The list of annotation spec sets.
- { # 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.
- "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
- "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
- "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
- "A String",
- ],
- "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
- "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
- { # 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`.
- "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
- "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
- "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
- },
- ],
- },
- ],
- "nextPageToken": "A String", # A token to retrieve next page of results.
- }</pre>
+ "annotationSpecSets": [ # The list of annotation spec sets.
+ { # 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.
+ "annotationSpecs": [ # Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
+ { # 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`.
+ "description": "A String", # Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name of the AnnotationSpec. Maximum of 64 characters.
+ "index": 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: "dog", index: 0 }` and one AnnotationSpec with `{ display_name: "cat", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.
+ },
+ ],
+ "blockingResources": [ # Output only. The names of any related resources that are blocking changes to the annotation spec set.
+ "A String",
+ ],
+ "description": "A String", # Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
+ "displayName": "A String", # Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
+ "name": "A String", # Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve next page of results.
+}</pre>
</div>
<div class="method">