diff --git a/packages/google-cloud-datalabeling/.eslintignore b/packages/google-cloud-datalabeling/.eslintignore index 09b31fe735a..9340ad9b86d 100644 --- a/packages/google-cloud-datalabeling/.eslintignore +++ b/packages/google-cloud-datalabeling/.eslintignore @@ -1,5 +1,6 @@ **/node_modules -src/**/doc/* +**/coverage +test/fixtures build/ docs/ protos/ diff --git a/packages/google-cloud-datalabeling/.prettierignore b/packages/google-cloud-datalabeling/.prettierignore index f6fac98b0a8..9340ad9b86d 100644 --- a/packages/google-cloud-datalabeling/.prettierignore +++ b/packages/google-cloud-datalabeling/.prettierignore @@ -1,3 +1,6 @@ -node_modules/* -samples/node_modules/* -src/**/doc/* +**/node_modules +**/coverage +test/fixtures +build/ +docs/ +protos/ diff --git a/packages/google-cloud-datalabeling/package.json b/packages/google-cloud-datalabeling/package.json index 057de591b3d..c3d35b49ed2 100644 --- a/packages/google-cloud-datalabeling/package.json +++ b/packages/google-cloud-datalabeling/package.json @@ -58,7 +58,6 @@ "mocha": "^6.1.4", "null-loader": "^3.0.0", "pack-n-play": "^1.0.0-2", - "prettier": "^1.13.6", "sinon": "^9.0.1", "ts-loader": "^6.2.1", "typescript": "^3.8.3", diff --git a/packages/google-cloud-datalabeling/samples/package.json b/packages/google-cloud-datalabeling/samples/package.json index d0e1c2a26dd..66a024de29d 100644 --- a/packages/google-cloud-datalabeling/samples/package.json +++ b/packages/google-cloud-datalabeling/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=8" + "node": ">=10" }, "files": [ "*.js", diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_annotation.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_annotation.js deleted file mode 100644 index 305bf0a3e29..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_annotation.js +++ /dev/null @@ -1,615 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Annotation for Example. Each example may have one or more annotations. For - * example in image classification problem, each image might have one or more - * labels. We call labels binded with this image an Annotation. - * - * @property {string} name - * Output only. Unique name of this annotation, format is: - * - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id} - * - * @property {number} annotationSource - * Output only. The source of the annotation. - * - * The number should be among the values of [AnnotationSource]{@link google.cloud.datalabeling.v1beta1.AnnotationSource} - * - * @property {Object} annotationValue - * Output only. This is the actual annotation value, e.g classification, - * bounding box values are stored here. - * - * This object should have the same structure as [AnnotationValue]{@link google.cloud.datalabeling.v1beta1.AnnotationValue} - * - * @property {Object} annotationMetadata - * Output only. Annotation metadata, including information like votes - * for labels. - * - * This object should have the same structure as [AnnotationMetadata]{@link google.cloud.datalabeling.v1beta1.AnnotationMetadata} - * - * @property {number} annotationSentiment - * Output only. Sentiment for this annotation. - * - * The number should be among the values of [AnnotationSentiment]{@link google.cloud.datalabeling.v1beta1.AnnotationSentiment} - * - * @typedef Annotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Annotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const Annotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Annotation value for an example. - * - * @property {Object} imageClassificationAnnotation - * Annotation value for image classification case. - * - * This object should have the same structure as [ImageClassificationAnnotation]{@link google.cloud.datalabeling.v1beta1.ImageClassificationAnnotation} - * - * @property {Object} imageBoundingPolyAnnotation - * Annotation value for image bounding box, oriented bounding box - * and polygon cases. - * - * This object should have the same structure as [ImageBoundingPolyAnnotation]{@link google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation} - * - * @property {Object} imagePolylineAnnotation - * Annotation value for image polyline cases. - * Polyline here is different from BoundingPoly. It is formed by - * line segments connected to each other but not closed form(Bounding Poly). - * The line segments can cross each other. - * - * This object should have the same structure as [ImagePolylineAnnotation]{@link google.cloud.datalabeling.v1beta1.ImagePolylineAnnotation} - * - * @property {Object} imageSegmentationAnnotation - * Annotation value for image segmentation. - * - * This object should have the same structure as [ImageSegmentationAnnotation]{@link google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation} - * - * @property {Object} textClassificationAnnotation - * Annotation value for text classification case. - * - * This object should have the same structure as [TextClassificationAnnotation]{@link google.cloud.datalabeling.v1beta1.TextClassificationAnnotation} - * - * @property {Object} textEntityExtractionAnnotation - * Annotation value for text entity extraction case. - * - * This object should have the same structure as [TextEntityExtractionAnnotation]{@link google.cloud.datalabeling.v1beta1.TextEntityExtractionAnnotation} - * - * @property {Object} videoClassificationAnnotation - * Annotation value for video classification case. - * - * This object should have the same structure as [VideoClassificationAnnotation]{@link google.cloud.datalabeling.v1beta1.VideoClassificationAnnotation} - * - * @property {Object} videoObjectTrackingAnnotation - * Annotation value for video object detection and tracking case. - * - * This object should have the same structure as [VideoObjectTrackingAnnotation]{@link google.cloud.datalabeling.v1beta1.VideoObjectTrackingAnnotation} - * - * @property {Object} videoEventAnnotation - * Annotation value for video event case. - * - * This object should have the same structure as [VideoEventAnnotation]{@link google.cloud.datalabeling.v1beta1.VideoEventAnnotation} - * - * @typedef AnnotationValue - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.AnnotationValue definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const AnnotationValue = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Image classification annotation definition. - * - * @property {Object} annotationSpec - * Label of image. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @typedef ImageClassificationAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImageClassificationAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const ImageClassificationAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A vertex represents a 2D point in the image. - * NOTE: the vertex coordinates are in the same scale as the original image. - * - * @property {number} x - * X coordinate. - * - * @property {number} y - * Y coordinate. - * - * @typedef Vertex - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Vertex definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const Vertex = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A vertex represents a 2D point in the image. - * NOTE: the normalized vertex coordinates are relative to the original image - * and range from 0 to 1. - * - * @property {number} x - * X coordinate. - * - * @property {number} y - * Y coordinate. - * - * @typedef NormalizedVertex - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.NormalizedVertex definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const NormalizedVertex = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A bounding polygon in the image. - * - * @property {Object[]} vertices - * The bounding polygon vertices. - * - * This object should have the same structure as [Vertex]{@link google.cloud.datalabeling.v1beta1.Vertex} - * - * @typedef BoundingPoly - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.BoundingPoly definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const BoundingPoly = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Normalized bounding polygon. - * - * @property {Object[]} normalizedVertices - * The bounding polygon normalized vertices. - * - * This object should have the same structure as [NormalizedVertex]{@link google.cloud.datalabeling.v1beta1.NormalizedVertex} - * - * @typedef NormalizedBoundingPoly - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.NormalizedBoundingPoly definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const NormalizedBoundingPoly = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Image bounding poly annotation. It represents a polygon including - * bounding box in the image. - * - * @property {Object} boundingPoly - * This object should have the same structure as [BoundingPoly]{@link google.cloud.datalabeling.v1beta1.BoundingPoly} - * - * @property {Object} normalizedBoundingPoly - * This object should have the same structure as [NormalizedBoundingPoly]{@link google.cloud.datalabeling.v1beta1.NormalizedBoundingPoly} - * - * @property {Object} annotationSpec - * Label of object in this bounding polygon. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @typedef ImageBoundingPolyAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImageBoundingPolyAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const ImageBoundingPolyAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A line with multiple line segments. - * - * @property {Object[]} vertices - * The polyline vertices. - * - * This object should have the same structure as [Vertex]{@link google.cloud.datalabeling.v1beta1.Vertex} - * - * @typedef Polyline - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Polyline definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const Polyline = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Normalized polyline. - * - * @property {Object[]} normalizedVertices - * The normalized polyline vertices. - * - * This object should have the same structure as [NormalizedVertex]{@link google.cloud.datalabeling.v1beta1.NormalizedVertex} - * - * @typedef NormalizedPolyline - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.NormalizedPolyline definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const NormalizedPolyline = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A polyline for the image annotation. - * - * @property {Object} polyline - * This object should have the same structure as [Polyline]{@link google.cloud.datalabeling.v1beta1.Polyline} - * - * @property {Object} normalizedPolyline - * This object should have the same structure as [NormalizedPolyline]{@link google.cloud.datalabeling.v1beta1.NormalizedPolyline} - * - * @property {Object} annotationSpec - * Label of this polyline. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @typedef ImagePolylineAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImagePolylineAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const ImagePolylineAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Image segmentation annotation. - * - * @property {Object.} annotationColors - * The mapping between rgb color and annotation spec. The key is the rgb - * color represented in format of rgb(0, 0, 0). The value is the - * AnnotationSpec. - * - * @property {string} mimeType - * Image format. - * - * @property {Buffer} imageBytes - * A byte string of a full image's color map. - * - * @typedef ImageSegmentationAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImageSegmentationAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const ImageSegmentationAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Text classification annotation. - * - * @property {Object} annotationSpec - * Label of the text. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @typedef TextClassificationAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TextClassificationAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const TextClassificationAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Text entity extraction annotation. - * - * @property {Object} annotationSpec - * Label of the text entities. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {Object} sequentialSegment - * Position of the entity. - * - * This object should have the same structure as [SequentialSegment]{@link google.cloud.datalabeling.v1beta1.SequentialSegment} - * - * @typedef TextEntityExtractionAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TextEntityExtractionAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const TextEntityExtractionAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Start and end position in a sequence (e.g. text segment). - * - * @property {number} start - * Start position (inclusive). - * - * @property {number} end - * End position (exclusive). - * - * @typedef SequentialSegment - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SequentialSegment definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const SequentialSegment = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * A time period inside of an example that has a time dimension (e.g. video). - * - * @property {Object} startTimeOffset - * Start of the time segment (inclusive), represented as the duration since - * the example start. - * - * This object should have the same structure as [Duration]{@link google.protobuf.Duration} - * - * @property {Object} endTimeOffset - * End of the time segment (exclusive), represented as the duration since the - * example start. - * - * This object should have the same structure as [Duration]{@link google.protobuf.Duration} - * - * @typedef TimeSegment - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TimeSegment definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const TimeSegment = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Video classification annotation. - * - * @property {Object} timeSegment - * The time segment of the video to which the annotation applies. - * - * This object should have the same structure as [TimeSegment]{@link google.cloud.datalabeling.v1beta1.TimeSegment} - * - * @property {Object} annotationSpec - * Label of the segment specified by time_segment. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @typedef VideoClassificationAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoClassificationAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const VideoClassificationAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Video frame level annotation for object detection and tracking. - * - * @property {Object} boundingPoly - * This object should have the same structure as [BoundingPoly]{@link google.cloud.datalabeling.v1beta1.BoundingPoly} - * - * @property {Object} normalizedBoundingPoly - * This object should have the same structure as [NormalizedBoundingPoly]{@link google.cloud.datalabeling.v1beta1.NormalizedBoundingPoly} - * - * @property {Object} timeOffset - * The time offset of this frame relative to the beginning of the video. - * - * This object should have the same structure as [Duration]{@link google.protobuf.Duration} - * - * @typedef ObjectTrackingFrame - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ObjectTrackingFrame definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const ObjectTrackingFrame = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Video object tracking annotation. - * - * @property {Object} annotationSpec - * Label of the object tracked in this annotation. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {Object} timeSegment - * The time segment of the video to which object tracking applies. - * - * This object should have the same structure as [TimeSegment]{@link google.cloud.datalabeling.v1beta1.TimeSegment} - * - * @property {Object[]} objectTrackingFrames - * The list of frames where this object track appears. - * - * This object should have the same structure as [ObjectTrackingFrame]{@link google.cloud.datalabeling.v1beta1.ObjectTrackingFrame} - * - * @typedef VideoObjectTrackingAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoObjectTrackingAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const VideoObjectTrackingAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Video event annotation. - * - * @property {Object} annotationSpec - * Label of the event in this annotation. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {Object} timeSegment - * The time segment of the video to which the annotation applies. - * - * This object should have the same structure as [TimeSegment]{@link google.cloud.datalabeling.v1beta1.TimeSegment} - * - * @typedef VideoEventAnnotation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoEventAnnotation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const VideoEventAnnotation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Additional information associated with the annotation. - * - * @property {Object} operatorMetadata - * Metadata related to human labeling. - * - * This object should have the same structure as [OperatorMetadata]{@link google.cloud.datalabeling.v1beta1.OperatorMetadata} - * - * @typedef AnnotationMetadata - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.AnnotationMetadata definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const AnnotationMetadata = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * General information useful for labels coming from contributors. - * - * @property {number} score - * Confidence score corresponding to a label. For examle, if 3 contributors - * have answered the question and 2 of them agree on the final label, the - * confidence score will be 0.67 (2/3). - * - * @property {number} totalVotes - * The total number of contributors that answer this question. - * - * @property {number} labelVotes - * The total number of contributors that choose this label. - * - * @property {string[]} comments - * Comments from contributors. - * - * @typedef OperatorMetadata - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.OperatorMetadata definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation.proto} - */ -const OperatorMetadata = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ -const AnnotationSentiment = { - ANNOTATION_SENTIMENT_UNSPECIFIED: 0, - - /** - * This annotation describes negatively about the data. - */ - NEGATIVE: 1, - - /** - * This label describes positively about the data. - */ - POSITIVE: 2 -}; - -/** - * Specifies where is the answer from. - * - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ -const AnnotationSource = { - ANNOTATION_SOURCE_UNSPECIFIED: 0, - - /** - * Answer is provided by a human contributor. - */ - OPERATOR: 3 -}; - -/** - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ -const AnnotationType = { - ANNOTATION_TYPE_UNSPECIFIED: 0, - - /** - * Classification annotations in an image. - */ - IMAGE_CLASSIFICATION_ANNOTATION: 1, - - /** - * Bounding box annotations in an image. - */ - IMAGE_BOUNDING_BOX_ANNOTATION: 2, - - /** - * Oriented bounding box. The box does not have to be parallel to horizontal - * line. - */ - IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION: 13, - - /** - * Bounding poly annotations in an image. - */ - IMAGE_BOUNDING_POLY_ANNOTATION: 10, - - /** - * Polyline annotations in an image. - */ - IMAGE_POLYLINE_ANNOTATION: 11, - - /** - * Segmentation annotations in an image. - */ - IMAGE_SEGMENTATION_ANNOTATION: 12, - - /** - * Classification annotations in video shots. - */ - VIDEO_SHOTS_CLASSIFICATION_ANNOTATION: 3, - - /** - * Video object tracking annotation. - */ - VIDEO_OBJECT_TRACKING_ANNOTATION: 4, - - /** - * Video object detection annotation. - */ - VIDEO_OBJECT_DETECTION_ANNOTATION: 5, - - /** - * Video event annotation. - */ - VIDEO_EVENT_ANNOTATION: 6, - - /** - * Classification for text. - */ - TEXT_CLASSIFICATION_ANNOTATION: 8, - - /** - * Entity extraction for text. - */ - TEXT_ENTITY_EXTRACTION_ANNOTATION: 9, - - /** - * General classification. - */ - GENERAL_CLASSIFICATION_ANNOTATION: 14 -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_annotation_spec_set.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_annotation_spec_set.js deleted file mode 100644 index 8dfbd18ffb9..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_annotation_spec_set.js +++ /dev/null @@ -1,68 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * AnnotationSpecSet is a collection of label definitions. For example, in - * image classification tasks, we define a set of labels, this set is called - * AnnotationSpecSet. AnnotationSpecSet is immutable upon creation. - * - * @property {string} name - * Output only. AnnotationSpecSet resource name, format: - * projects/{project_id}/annotationSpecSets/{annotation_spec_set_id} - * - * @property {string} displayName - * Required. The display name for AnnotationSpecSet defined by user. - * Maximum of 64 characters. - * - * @property {string} description - * Optional. User-provided description of the annotation specification set. - * The description can be up to 10000 characters long. - * - * @property {Object[]} annotationSpecs - * Required. The actual spec set defined by the users. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {string[]} blockingResources - * Output only. The names of any related resources that are blocking changes - * to the annotation spec set. - * - * @typedef AnnotationSpecSet - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.AnnotationSpecSet definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation_spec_set.proto} - */ -const AnnotationSpecSet = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Container of information related to one annotation spec. - * - * @property {string} displayName - * Required. The display name of the AnnotationSpec. Maximum of 64 characters. - * - * @property {string} description - * Optional. User-provided description of the annotation specification. - * The description can be up to 10000 characters long. - * - * @typedef AnnotationSpec - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.AnnotationSpec definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/annotation_spec_set.proto} - */ -const AnnotationSpec = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_data_labeling_service.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_data_labeling_service.js deleted file mode 100644 index cfdec432a7a..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_data_labeling_service.js +++ /dev/null @@ -1,1104 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Request message for CreateDataset. - * - * @property {string} parent - * Required. Dataset resource parent, format: - * projects/{project_id} - * - * @property {Object} dataset - * Required. The dataset to be created. - * - * This object should have the same structure as [Dataset]{@link google.cloud.datalabeling.v1beta1.Dataset} - * - * @typedef CreateDatasetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.CreateDatasetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const CreateDatasetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetDataSet. - * - * @property {string} name - * Required. Dataset resource name, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @typedef GetDatasetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetDatasetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetDatasetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListDataset. - * - * @property {string} parent - * Required. Dataset resource parent, format: - * projects/{project_id} - * - * @property {string} filter - * Optional. Filter on dataset is not supported at this moment. - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * ListDatasetsResponse.next_page_token - * of the previous [DataLabelingService.ListDatasets] call. Returns the first - * page if empty. - * - * @typedef ListDatasetsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListDatasetsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListDatasetsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of listing datasets within a project. - * - * @property {Object[]} datasets - * The list of datasets to return. - * - * This object should have the same structure as [Dataset]{@link google.cloud.datalabeling.v1beta1.Dataset} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListDatasetsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListDatasetsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListDatasetsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for DeleteDataset. - * - * @property {string} name - * Required. Dataset resource name, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @typedef DeleteDatasetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.DeleteDatasetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const DeleteDatasetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ImportData API. - * - * @property {string} name - * Required. Dataset resource name, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {Object} inputConfig - * Required. Specify the input source of the data. - * - * This object should have the same structure as [InputConfig]{@link google.cloud.datalabeling.v1beta1.InputConfig} - * - * @property {string} userEmailAddress - * Email of the user who started the import task and should be notified by - * email. If empty no notification will be sent. - * - * @typedef ImportDataRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImportDataRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ImportDataRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ExportData API. - * - * @property {string} name - * Required. Dataset resource name, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {string} annotatedDataset - * Required. Annotated dataset resource name. DataItem in - * Dataset and their annotations in specified annotated dataset will be - * exported. It's in format of - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ - * {annotated_dataset_id} - * - * @property {string} filter - * Optional. Filter is not supported at this moment. - * - * @property {Object} outputConfig - * Required. Specify the output destination. - * - * This object should have the same structure as [OutputConfig]{@link google.cloud.datalabeling.v1beta1.OutputConfig} - * - * @property {string} userEmailAddress - * Email of the user who started the export task and should be notified by - * email. If empty no notification will be sent. - * - * @typedef ExportDataRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ExportDataRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ExportDataRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetDataItem. - * - * @property {string} name - * Required. The name of the data item to get, format: - * projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} - * - * @typedef GetDataItemRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetDataItemRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetDataItemRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListDataItems. - * - * @property {string} parent - * Required. Name of the dataset to list data items, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {string} filter - * Optional. Filter is not supported at this moment. - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * ListDataItemsResponse.next_page_token - * of the previous [DataLabelingService.ListDataItems] call. Return first page - * if empty. - * - * @typedef ListDataItemsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListDataItemsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListDataItemsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of listing data items in a dataset. - * - * @property {Object[]} dataItems - * The list of data items to return. - * - * This object should have the same structure as [DataItem]{@link google.cloud.datalabeling.v1beta1.DataItem} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListDataItemsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListDataItemsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListDataItemsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetAnnotatedDataset. - * - * @property {string} name - * Required. Name of the annotated dataset to get, format: - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ - * {annotated_dataset_id} - * - * @typedef GetAnnotatedDatasetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetAnnotatedDatasetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetAnnotatedDatasetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListAnnotatedDatasets. - * - * @property {string} parent - * Required. Name of the dataset to list annotated datasets, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {string} filter - * Optional. Filter is not supported at this moment. - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * ListAnnotatedDatasetsResponse.next_page_token - * of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return - * first page if empty. - * - * @typedef ListAnnotatedDatasetsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListAnnotatedDatasetsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of listing annotated datasets for a dataset. - * - * @property {Object[]} annotatedDatasets - * The list of annotated datasets to return. - * - * This object should have the same structure as [AnnotatedDataset]{@link google.cloud.datalabeling.v1beta1.AnnotatedDataset} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListAnnotatedDatasetsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListAnnotatedDatasetsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for DeleteAnnotatedDataset. - * - * @property {string} name - * Required. Name of the annotated dataset to delete, format: - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ - * {annotated_dataset_id} - * - * @typedef DeleteAnnotatedDatasetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.DeleteAnnotatedDatasetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const DeleteAnnotatedDatasetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for starting an image labeling task. - * - * @property {Object} imageClassificationConfig - * Configuration for image classification task. - * One of image_classification_config, bounding_poly_config, - * polyline_config and segmentation_config are required. - * - * This object should have the same structure as [ImageClassificationConfig]{@link google.cloud.datalabeling.v1beta1.ImageClassificationConfig} - * - * @property {Object} boundingPolyConfig - * Configuration for bounding box and bounding poly task. - * One of image_classification_config, bounding_poly_config, - * polyline_config and segmentation_config are required. - * - * This object should have the same structure as [BoundingPolyConfig]{@link google.cloud.datalabeling.v1beta1.BoundingPolyConfig} - * - * @property {Object} polylineConfig - * Configuration for polyline task. - * One of image_classification_config, bounding_poly_config, - * polyline_config and segmentation_config are required. - * - * This object should have the same structure as [PolylineConfig]{@link google.cloud.datalabeling.v1beta1.PolylineConfig} - * - * @property {Object} segmentationConfig - * Configuration for segmentation task. - * One of image_classification_config, bounding_poly_config, - * polyline_config and segmentation_config are required. - * - * This object should have the same structure as [SegmentationConfig]{@link google.cloud.datalabeling.v1beta1.SegmentationConfig} - * - * @property {string} parent - * Required. Name of the dataset to request labeling task, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {Object} basicConfig - * Required. Basic human annotation config. - * - * This object should have the same structure as [HumanAnnotationConfig]{@link google.cloud.datalabeling.v1beta1.HumanAnnotationConfig} - * - * @property {number} feature - * Required. The type of image labeling task. - * - * The number should be among the values of [Feature]{@link google.cloud.datalabeling.v1beta1.Feature} - * - * @typedef LabelImageRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.LabelImageRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const LabelImageRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Image labeling task feature. - * - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ - Feature: { - FEATURE_UNSPECIFIED: 0, - - /** - * Label whole image with one or more of labels. - */ - CLASSIFICATION: 1, - - /** - * Label image with bounding boxes for labels. - */ - BOUNDING_BOX: 2, - - /** - * Label oriented bounding box. The box does not have to be parallel to - * horizontal line. - */ - ORIENTED_BOUNDING_BOX: 6, - - /** - * Label images with bounding poly. A bounding poly is a plane figure that - * is bounded by a finite chain of straight line segments closing in a loop. - */ - BOUNDING_POLY: 3, - - /** - * Label images with polyline. Polyline is formed by connected line segments - * which are not in closed form. - */ - POLYLINE: 4, - - /** - * Label images with segmentation. Segmentation is different from bounding - * poly since it is more fine-grained, pixel level annotation. - */ - SEGMENTATION: 5 - } -}; - -/** - * Request message for LabelVideo. - * - * @property {Object} videoClassificationConfig - * Configuration for video classification task. - * One of video_classification_config, object_detection_config, - * object_tracking_config and event_config is required. - * - * This object should have the same structure as [VideoClassificationConfig]{@link google.cloud.datalabeling.v1beta1.VideoClassificationConfig} - * - * @property {Object} objectDetectionConfig - * Configuration for video object detection task. - * One of video_classification_config, object_detection_config, - * object_tracking_config and event_config is required. - * - * This object should have the same structure as [ObjectDetectionConfig]{@link google.cloud.datalabeling.v1beta1.ObjectDetectionConfig} - * - * @property {Object} objectTrackingConfig - * Configuration for video object tracking task. - * One of video_classification_config, object_detection_config, - * object_tracking_config and event_config is required. - * - * This object should have the same structure as [ObjectTrackingConfig]{@link google.cloud.datalabeling.v1beta1.ObjectTrackingConfig} - * - * @property {Object} eventConfig - * Configuration for video event task. - * One of video_classification_config, object_detection_config, - * object_tracking_config and event_config is required. - * - * This object should have the same structure as [EventConfig]{@link google.cloud.datalabeling.v1beta1.EventConfig} - * - * @property {string} parent - * Required. Name of the dataset to request labeling task, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {Object} basicConfig - * Required. Basic human annotation config. - * - * This object should have the same structure as [HumanAnnotationConfig]{@link google.cloud.datalabeling.v1beta1.HumanAnnotationConfig} - * - * @property {number} feature - * Required. The type of video labeling task. - * - * The number should be among the values of [Feature]{@link google.cloud.datalabeling.v1beta1.Feature} - * - * @typedef LabelVideoRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.LabelVideoRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const LabelVideoRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Video labeling task feature. - * - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ - Feature: { - FEATURE_UNSPECIFIED: 0, - - /** - * Label whole video or video segment with one or more labels. - */ - CLASSIFICATION: 1, - - /** - * Label objects with bounding box on image frames extracted from the video. - */ - OBJECT_DETECTION: 2, - - /** - * Label and track objects in video. - */ - OBJECT_TRACKING: 3, - - /** - * Label the range of video for the specified events. - */ - EVENT: 4 - } -}; - -/** - * Request message for LabelText. - * - * @property {Object} textClassificationConfig - * Configuration for text classification task. - * One of text_classification_config and text_entity_extraction_config - * is required. - * - * This object should have the same structure as [TextClassificationConfig]{@link google.cloud.datalabeling.v1beta1.TextClassificationConfig} - * - * @property {Object} textEntityExtractionConfig - * Configuration for entity extraction task. - * One of text_classification_config and text_entity_extraction_config - * is required. - * - * This object should have the same structure as [TextEntityExtractionConfig]{@link google.cloud.datalabeling.v1beta1.TextEntityExtractionConfig} - * - * @property {string} parent - * Required. Name of the data set to request labeling task, format: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {Object} basicConfig - * Required. Basic human annotation config. - * - * This object should have the same structure as [HumanAnnotationConfig]{@link google.cloud.datalabeling.v1beta1.HumanAnnotationConfig} - * - * @property {number} feature - * Required. The type of text labeling task. - * - * The number should be among the values of [Feature]{@link google.cloud.datalabeling.v1beta1.Feature} - * - * @typedef LabelTextRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.LabelTextRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const LabelTextRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Text labeling task feature. - * - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ - Feature: { - FEATURE_UNSPECIFIED: 0, - - /** - * Label text content to one of more labels. - */ - TEXT_CLASSIFICATION: 1, - - /** - * Label entities and their span in text. - */ - TEXT_ENTITY_EXTRACTION: 2 - } -}; - -/** - * Request message for GetExample - * - * @property {string} name - * Required. Name of example, format: - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ - * {annotated_dataset_id}/examples/{example_id} - * - * @property {string} filter - * Optional. An expression for filtering Examples. Filter by - * annotation_spec.display_name is supported. Format - * "annotation_spec.display_name = {display_name}" - * - * @typedef GetExampleRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetExampleRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetExampleRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListExamples. - * - * @property {string} parent - * Required. Example resource parent. - * - * @property {string} filter - * Optional. An expression for filtering Examples. For annotated datasets that - * have annotation spec set, filter by - * annotation_spec.display_name is supported. Format - * "annotation_spec.display_name = {display_name}" - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * ListExamplesResponse.next_page_token - * of the previous [DataLabelingService.ListExamples] call. Return first page - * if empty. - * - * @typedef ListExamplesRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListExamplesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListExamplesRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of listing Examples in and annotated dataset. - * - * @property {Object[]} examples - * The list of examples to return. - * - * This object should have the same structure as [Example]{@link google.cloud.datalabeling.v1beta1.Example} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListExamplesResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListExamplesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListExamplesResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for CreateAnnotationSpecSet. - * - * @property {string} parent - * Required. AnnotationSpecSet resource parent, format: - * projects/{project_id} - * - * @property {Object} annotationSpecSet - * 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. - * - * This object should have the same structure as [AnnotationSpecSet]{@link google.cloud.datalabeling.v1beta1.AnnotationSpecSet} - * - * @typedef CreateAnnotationSpecSetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.CreateAnnotationSpecSetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const CreateAnnotationSpecSetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetAnnotationSpecSet. - * - * @property {string} name - * Required. AnnotationSpecSet resource name, format: - * projects/{project_id}/annotationSpecSets/{annotation_spec_set_id} - * - * @typedef GetAnnotationSpecSetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetAnnotationSpecSetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetAnnotationSpecSetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListAnnotationSpecSets. - * - * @property {string} parent - * Required. Parent of AnnotationSpecSet resource, format: - * projects/{project_id} - * - * @property {string} filter - * Optional. Filter is not supported at this moment. - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * 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. - * - * @typedef ListAnnotationSpecSetsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListAnnotationSpecSetsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of listing annotation spec set under a project. - * - * @property {Object[]} annotationSpecSets - * The list of annotation spec sets. - * - * This object should have the same structure as [AnnotationSpecSet]{@link google.cloud.datalabeling.v1beta1.AnnotationSpecSet} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListAnnotationSpecSetsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListAnnotationSpecSetsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for DeleteAnnotationSpecSet. - * - * @property {string} name - * Required. AnnotationSpec resource name, format: - * `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`. - * - * @typedef DeleteAnnotationSpecSetRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.DeleteAnnotationSpecSetRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const DeleteAnnotationSpecSetRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for CreateInstruction. - * - * @property {string} parent - * Required. Instruction resource parent, format: - * projects/{project_id} - * - * @property {Object} instruction - * Required. Instruction of how to perform the labeling task. - * - * This object should have the same structure as [Instruction]{@link google.cloud.datalabeling.v1beta1.Instruction} - * - * @typedef CreateInstructionRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.CreateInstructionRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const CreateInstructionRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetInstruction. - * - * @property {string} name - * Required. Instruction resource name, format: - * projects/{project_id}/instructions/{instruction_id} - * - * @typedef GetInstructionRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetInstructionRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetInstructionRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for DeleteInstruction. - * - * @property {string} name - * Required. Instruction resource name, format: - * projects/{project_id}/instructions/{instruction_id} - * - * @typedef DeleteInstructionRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.DeleteInstructionRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const DeleteInstructionRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListInstructions. - * - * @property {string} parent - * Required. Instruction resource parent, format: - * projects/{project_id} - * - * @property {string} filter - * Optional. Filter is not supported at this moment. - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * ListInstructionsResponse.next_page_token - * of the previous [DataLabelingService.ListInstructions] call. Return first - * page if empty. - * - * @typedef ListInstructionsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListInstructionsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListInstructionsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of listing instructions under a project. - * - * @property {Object[]} instructions - * The list of Instructions to return. - * - * This object should have the same structure as [Instruction]{@link google.cloud.datalabeling.v1beta1.Instruction} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListInstructionsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListInstructionsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListInstructionsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetEvaluation. - * - * @property {string} name - * Required. Name of the evaluation. Format: - * 'projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}' - * - * @typedef GetEvaluationRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetEvaluationRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetEvaluationRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for SearchEvaluation. - * - * @property {string} parent - * Required. Evaluation search parent. Format: - * projects/{project_id} - * - * @property {string} filter - * Optional. Support filtering by model id, job state, start and end time. - * Format: - * "evaluation_job.evaluation_job_id = {evaluation_job_id} AND - * evaluation_job.evaluation_job_run_time_start = {timestamp} AND - * evaluation_job.evaluation_job_run_time_end = {timestamp} AND - * annotation_spec.display_name = {display_name}" - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * SearchEvaluationsResponse.next_page_token - * of the previous [DataLabelingService.SearchEvaluations] call. Return first - * page if empty. - * - * @typedef SearchEvaluationsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const SearchEvaluationsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of searching evaluations. - * - * @property {Object[]} evaluations - * The list of evaluations to return. - * - * This object should have the same structure as [Evaluation]{@link google.cloud.datalabeling.v1beta1.Evaluation} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef SearchEvaluationsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const SearchEvaluationsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message of SearchExampleComparisons. - * - * @property {string} parent - * Required. Name of the Evaluation resource to search example comparison - * from. Format: - * projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id} - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * SearchExampleComparisons.next_page_token of the previous - * [DataLabelingService.SearchExampleComparisons] call. - * Return first page if empty. - * - * @typedef SearchExampleComparisonsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SearchExampleComparisonsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const SearchExampleComparisonsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results of searching example comparisons. - * - * @property {Object[]} exampleComparisons - * This object should have the same structure as [ExampleComparison]{@link google.cloud.datalabeling.v1beta1.ExampleComparison} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef SearchExampleComparisonsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const SearchExampleComparisonsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Example comparisons containing annotation comparison between groundtruth - * and predictions. - * - * @property {Object} groundTruthExample - * This object should have the same structure as [Example]{@link google.cloud.datalabeling.v1beta1.Example} - * - * @property {Object[]} modelCreatedExamples - * This object should have the same structure as [Example]{@link google.cloud.datalabeling.v1beta1.Example} - * - * @typedef ExampleComparison - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ - ExampleComparison: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; - -/** - * Request message for CreateEvaluationJob. - * - * @property {string} parent - * Required. Evaluation job resource parent, format: - * projects/{project_id}. - * - * @property {Object} job - * Required. The evaluation job to create. - * - * This object should have the same structure as [EvaluationJob]{@link google.cloud.datalabeling.v1beta1.EvaluationJob} - * - * @typedef CreateEvaluationJobRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.CreateEvaluationJobRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const CreateEvaluationJobRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for UpdateEvaluationJob. - * - * @property {Object} evaluationJob - * Required. Evaluation job that is going to be updated. - * - * This object should have the same structure as [EvaluationJob]{@link google.cloud.datalabeling.v1beta1.EvaluationJob} - * - * @property {Object} updateMask - * Optional. Mask for which field in evaluation_job should be updated. - * - * This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask} - * - * @typedef UpdateEvaluationJobRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.UpdateEvaluationJobRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const UpdateEvaluationJobRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for GetEvaluationJob. - * - * @property {string} name - * Required. Name of the evaluation job. Format: - * 'projects/{project_id}/evaluationJobs/{evaluation_job_id}' - * - * @typedef GetEvaluationJobRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GetEvaluationJobRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const GetEvaluationJobRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for PauseEvaluationJob. - * - * @property {string} name - * Required. Name of the evaluation job that is going to be paused. Format: - * 'projects/{project_id}/evaluationJobs/{evaluation_job_id}' - * - * @typedef PauseEvaluationJobRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.PauseEvaluationJobRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const PauseEvaluationJobRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message ResumeEvaluationJob. - * - * @property {string} name - * Required. Name of the evaluation job that is going to be resumed. Format: - * 'projects/{project_id}/evaluationJobs/{evaluation_job_id}' - * - * @typedef ResumeEvaluationJobRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ResumeEvaluationJobRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ResumeEvaluationJobRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message DeleteEvaluationJob. - * - * @property {string} name - * Required. Name of the evaluation job that is going to be deleted. Format: - * 'projects/{project_id}/evaluationJobs/{evaluation_job_id}' - * - * @typedef DeleteEvaluationJobRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.DeleteEvaluationJobRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const DeleteEvaluationJobRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Request message for ListEvaluationJobs. - * - * @property {string} parent - * Required. Evaluation resource parent. Format: - * "projects/{project_id}" - * - * @property {string} filter - * Optional. Only support filter by model id and job state. Format: - * "evaluation_job.model_id = {model_id} AND evaluation_job.state = - * {EvaluationJob::State}" - * - * @property {number} pageSize - * Optional. Requested page size. Server may return fewer results than - * requested. Default value is 100. - * - * @property {string} pageToken - * Optional. A token identifying a page of results for the server to return. - * Typically obtained by - * ListEvaluationJobs.next_page_token of the previous - * [DataLabelingService.ListEvaluationJobs] call. - * Return first page if empty. - * - * @typedef ListEvaluationJobsRequest - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListEvaluationJobsRequest = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Results for listing evaluation jobs. - * - * @property {Object[]} evaluationJobs - * The list of evaluation jobs to return. - * - * This object should have the same structure as [EvaluationJob]{@link google.cloud.datalabeling.v1beta1.EvaluationJob} - * - * @property {string} nextPageToken - * A token to retrieve next page of results. - * - * @typedef ListEvaluationJobsResponse - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_labeling_service.proto} - */ -const ListEvaluationJobsResponse = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_data_payloads.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_data_payloads.js deleted file mode 100644 index 0b64ae3d9f4..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_data_payloads.js +++ /dev/null @@ -1,101 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Container of information about an image. - * - * @property {string} mimeType - * Image format. - * - * @property {Buffer} imageThumbnail - * A byte string of a thumbnail image. - * - * @property {string} imageUri - * Image uri from the user bucket. - * - * @property {string} signedUri - * Signed uri of the image file in the service bucket. - * - * @typedef ImagePayload - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImagePayload definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_payloads.proto} - */ -const ImagePayload = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Container of information about a piece of text. - * - * @property {string} textContent - * Text content. - * - * @typedef TextPayload - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TextPayload definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_payloads.proto} - */ -const TextPayload = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Container of information of a video thumbnail. - * - * @property {Buffer} thumbnail - * A byte string of the video frame. - * - * @property {Object} timeOffset - * Time offset relative to the beginning of the video, corresponding to the - * video frame where the thumbnail has been extracted from. - * - * This object should have the same structure as [Duration]{@link google.protobuf.Duration} - * - * @typedef VideoThumbnail - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoThumbnail definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_payloads.proto} - */ -const VideoThumbnail = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Container of information of a video. - * - * @property {string} mimeType - * Video format. - * - * @property {string} videoUri - * Video uri from the user bucket. - * - * @property {Object[]} videoThumbnails - * The list of video thumbnails. - * - * This object should have the same structure as [VideoThumbnail]{@link google.cloud.datalabeling.v1beta1.VideoThumbnail} - * - * @property {number} frameRate - * FPS of the video. - * - * @property {string} signedUri - * Signed uri of the video file in the service bucket. - * - * @typedef VideoPayload - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoPayload definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/data_payloads.proto} - */ -const VideoPayload = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_dataset.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_dataset.js deleted file mode 100644 index 639c5df2739..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_dataset.js +++ /dev/null @@ -1,451 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Dataset is the resource to hold your data. You can request multiple labeling - * tasks for a dataset while each one will generate an AnnotatedDataset. - * - * @property {string} name - * Output only. Dataset resource name, format is: - * projects/{project_id}/datasets/{dataset_id} - * - * @property {string} displayName - * Required. The display name of the dataset. Maximum of 64 characters. - * - * @property {string} description - * Optional. User-provided description of the annotation specification set. - * The description can be up to 10000 characters long. - * - * @property {Object} createTime - * Output only. Time the dataset is created. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object[]} inputConfigs - * Output only. This is populated with the original input configs - * where ImportData is called. It is available only after the clients - * import data to this dataset. - * - * This object should have the same structure as [InputConfig]{@link google.cloud.datalabeling.v1beta1.InputConfig} - * - * @property {string[]} blockingResources - * Output only. The names of any related resources that are blocking changes - * to the dataset. - * - * @property {number} dataItemCount - * Output only. The number of data items in the dataset. - * - * @typedef Dataset - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Dataset definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const Dataset = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * The configuration of input data, including data type, location, etc. - * - * @property {Object} textMetadata - * Required for text import, as language code must be specified. - * - * This object should have the same structure as [TextMetadata]{@link google.cloud.datalabeling.v1beta1.TextMetadata} - * - * @property {Object} gcsSource - * Source located in Cloud Storage. - * - * This object should have the same structure as [GcsSource]{@link google.cloud.datalabeling.v1beta1.GcsSource} - * - * @property {Object} bigquerySource - * This object should have the same structure as [BigQuerySource]{@link google.cloud.datalabeling.v1beta1.BigQuerySource} - * - * @property {number} dataType - * Required. Data type must be specifed when user tries to import data. - * - * The number should be among the values of [DataType]{@link google.cloud.datalabeling.v1beta1.DataType} - * - * @property {number} annotationType - * Optional. If input contains annotation, user needs to specify the - * type and metadata of the annotation when creating it as an annotated - * dataset. - * - * The number should be among the values of [AnnotationType]{@link google.cloud.datalabeling.v1beta1.AnnotationType} - * - * @property {Object} classificationMetadata - * Optional. Metadata about annotations in the input. Each annotation type may - * have different metadata. - * Metadata for classification problem. - * - * This object should have the same structure as [ClassificationMetadata]{@link google.cloud.datalabeling.v1beta1.ClassificationMetadata} - * - * @typedef InputConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.InputConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const InputConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Metadata for the text. - * - * @property {string} languageCode - * The language of this text, as a - * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). - * Default value is en-US. - * - * @typedef TextMetadata - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TextMetadata definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const TextMetadata = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Metadata for classification annotations. - * - * @property {boolean} isMultiLabel - * Whether the classification task is multi-label or not. - * - * @typedef ClassificationMetadata - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ClassificationMetadata definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const ClassificationMetadata = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Source of the Cloud Storage file to be imported. - * - * @property {string} inputUri - * Required. The input URI of source file. This must be a Cloud Storage path - * (`gs://...`). - * - * @property {string} mimeType - * Required. The format of the source file. Only "text/csv" is supported. - * - * @typedef GcsSource - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GcsSource definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const GcsSource = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * The BigQuery location for the input content. - * - * @property {string} inputUri - * Required. BigQuery URI to a table, up to 2000 characters long. - * Accepted forms: BigQuery gs path e.g. bq://projectId.bqDatasetId.bqTableId - * - * @typedef BigQuerySource - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.BigQuerySource definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const BigQuerySource = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * The configuration of output data. - * - * @property {Object} gcsDestination - * Output to a file in Cloud Storage. Should be used for labeling output - * other than image segmentation. - * - * This object should have the same structure as [GcsDestination]{@link google.cloud.datalabeling.v1beta1.GcsDestination} - * - * @property {Object} gcsFolderDestination - * Output to a folder in Cloud Storage. Should be used for image - * segmentation labeling output. - * - * This object should have the same structure as [GcsFolderDestination]{@link google.cloud.datalabeling.v1beta1.GcsFolderDestination} - * - * @typedef OutputConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.OutputConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const OutputConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Export destination of the data.Only gcs path is allowed in - * output_uri. - * - * @property {string} outputUri - * Required. The output uri of destination file. - * - * @property {string} mimeType - * Required. The format of the gcs destination. Only "text/csv" and - * "application/json" - * are supported. - * - * @typedef GcsDestination - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GcsDestination definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const GcsDestination = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Export folder destination of the data. - * - * @property {string} outputFolderUri - * Required. Cloud Storage directory to export data to. - * - * @typedef GcsFolderDestination - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.GcsFolderDestination definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const GcsFolderDestination = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * DataItem is a piece of data, without annotation. For example, an image. - * - * @property {Object} imagePayload - * The image payload, a container of the image bytes/uri. - * - * This object should have the same structure as [ImagePayload]{@link google.cloud.datalabeling.v1beta1.ImagePayload} - * - * @property {Object} textPayload - * The text payload, a container of text content. - * - * This object should have the same structure as [TextPayload]{@link google.cloud.datalabeling.v1beta1.TextPayload} - * - * @property {Object} videoPayload - * The video payload, a container of the video uri. - * - * This object should have the same structure as [VideoPayload]{@link google.cloud.datalabeling.v1beta1.VideoPayload} - * - * @property {string} name - * Output only. Name of the data item, in format of: - * projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} - * - * @typedef DataItem - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.DataItem definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const DataItem = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * AnnotatedDataset is a set holding annotations for data in a Dataset. Each - * labeling task will generate an AnnotatedDataset under the Dataset that the - * task is requested for. - * - * @property {string} name - * Output only. AnnotatedDataset resource name in format of: - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ - * {annotated_dataset_id} - * - * @property {string} displayName - * Output only. The display name of the AnnotatedDataset. It is specified in - * HumanAnnotationConfig when user starts a labeling task. Maximum of 64 - * characters. - * - * @property {string} description - * Output only. The description of the AnnotatedDataset. It is specified in - * HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 - * characters. - * - * @property {number} annotationSource - * Output only. Source of the annotation. - * - * The number should be among the values of [AnnotationSource]{@link google.cloud.datalabeling.v1beta1.AnnotationSource} - * - * @property {number} annotationType - * Output only. Type of the annotation. It is specified when starting labeling - * task. - * - * The number should be among the values of [AnnotationType]{@link google.cloud.datalabeling.v1beta1.AnnotationType} - * - * @property {number} exampleCount - * Output only. Number of examples in the annotated dataset. - * - * @property {number} completedExampleCount - * Output only. Number of examples that have annotation in the annotated - * dataset. - * - * @property {Object} labelStats - * Output only. Per label statistics. - * - * This object should have the same structure as [LabelStats]{@link google.cloud.datalabeling.v1beta1.LabelStats} - * - * @property {Object} createTime - * Output only. Time the AnnotatedDataset was created. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} metadata - * Output only. Additional information about AnnotatedDataset. - * - * This object should have the same structure as [AnnotatedDatasetMetadata]{@link google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata} - * - * @property {string[]} blockingResources - * Output only. The names of any related resources that are blocking changes - * to the annotated dataset. - * - * @typedef AnnotatedDataset - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.AnnotatedDataset definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const AnnotatedDataset = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Statistics about annotation specs. - * - * @property {Object.} exampleCount - * Map of each annotation spec's example count. Key is the annotation spec - * name and value is the number of examples for that annotation spec. - * If the annotated dataset does not have annotation spec, the map will return - * a pair where the key is empty string and value is the total number of - * annotations. - * - * @typedef LabelStats - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.LabelStats definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const LabelStats = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Metadata on AnnotatedDataset. - * - * @property {Object} imageClassificationConfig - * Configuration for image classification task. - * - * This object should have the same structure as [ImageClassificationConfig]{@link google.cloud.datalabeling.v1beta1.ImageClassificationConfig} - * - * @property {Object} boundingPolyConfig - * Configuration for image bounding box and bounding poly task. - * - * This object should have the same structure as [BoundingPolyConfig]{@link google.cloud.datalabeling.v1beta1.BoundingPolyConfig} - * - * @property {Object} polylineConfig - * Configuration for image polyline task. - * - * This object should have the same structure as [PolylineConfig]{@link google.cloud.datalabeling.v1beta1.PolylineConfig} - * - * @property {Object} segmentationConfig - * Configuration for image segmentation task. - * - * This object should have the same structure as [SegmentationConfig]{@link google.cloud.datalabeling.v1beta1.SegmentationConfig} - * - * @property {Object} videoClassificationConfig - * Configuration for video classification task. - * - * This object should have the same structure as [VideoClassificationConfig]{@link google.cloud.datalabeling.v1beta1.VideoClassificationConfig} - * - * @property {Object} objectDetectionConfig - * Configuration for video object detection task. - * - * This object should have the same structure as [ObjectDetectionConfig]{@link google.cloud.datalabeling.v1beta1.ObjectDetectionConfig} - * - * @property {Object} objectTrackingConfig - * Configuration for video object tracking task. - * - * This object should have the same structure as [ObjectTrackingConfig]{@link google.cloud.datalabeling.v1beta1.ObjectTrackingConfig} - * - * @property {Object} eventConfig - * Configuration for video event labeling task. - * - * This object should have the same structure as [EventConfig]{@link google.cloud.datalabeling.v1beta1.EventConfig} - * - * @property {Object} textClassificationConfig - * Configuration for text classification task. - * - * This object should have the same structure as [TextClassificationConfig]{@link google.cloud.datalabeling.v1beta1.TextClassificationConfig} - * - * @property {Object} textEntityExtractionConfig - * Configuration for text entity extraction task. - * - * This object should have the same structure as [TextEntityExtractionConfig]{@link google.cloud.datalabeling.v1beta1.TextEntityExtractionConfig} - * - * @property {Object} humanAnnotationConfig - * HumanAnnotationConfig used when requesting the human labeling task for this - * AnnotatedDataset. - * - * This object should have the same structure as [HumanAnnotationConfig]{@link google.cloud.datalabeling.v1beta1.HumanAnnotationConfig} - * - * @typedef AnnotatedDatasetMetadata - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const AnnotatedDatasetMetadata = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * An Example is a piece of data and its annotation. For example, an image with - * label "house". - * - * @property {Object} imagePayload - * The image payload, a container of the image bytes/uri. - * - * This object should have the same structure as [ImagePayload]{@link google.cloud.datalabeling.v1beta1.ImagePayload} - * - * @property {Object} textPayload - * The text payload, a container of the text content. - * - * This object should have the same structure as [TextPayload]{@link google.cloud.datalabeling.v1beta1.TextPayload} - * - * @property {Object} videoPayload - * The video payload, a container of the video uri. - * - * This object should have the same structure as [VideoPayload]{@link google.cloud.datalabeling.v1beta1.VideoPayload} - * - * @property {string} name - * Output only. Name of the example, in format of: - * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ - * {annotated_dataset_id}/examples/{example_id} - * - * @property {Object[]} annotations - * Output only. Annotations for the piece of data in Example. - * One piece of data can have multiple annotations. - * - * This object should have the same structure as [Annotation]{@link google.cloud.datalabeling.v1beta1.Annotation} - * - * @typedef Example - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Example definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/dataset.proto} - */ -const Example = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ -const DataType = { - DATA_TYPE_UNSPECIFIED: 0, - IMAGE: 1, - VIDEO: 2, - TEXT: 4, - GENERAL_DATA: 6 -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_evaluation.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_evaluation.js deleted file mode 100644 index 07dcfddb3c0..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_evaluation.js +++ /dev/null @@ -1,260 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Describes an evaluation between 2 annotated datasets. Created by an - * evaluation plan. - * - * @property {string} name - * Resource name of an evaluation. - * Format: - * 'projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}' - * - * @property {Object} config - * Options used in evaluation plan for creating the evaluation. - * - * This object should have the same structure as [EvaluationConfig]{@link google.cloud.datalabeling.v1beta1.EvaluationConfig} - * - * @property {Object} evaluationJobRunTime - * Output only. Timestamp when the evaluation plan triggered this evaluation - * flow. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} createTime - * Output only. Timestamp when this model evaluation was created. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} evaluationMetrics - * Output only. Metrics of the evaluation. - * - * This object should have the same structure as [EvaluationMetrics]{@link google.cloud.datalabeling.v1beta1.EvaluationMetrics} - * - * @property {number} annotationType - * Type of the annotation to compute metrics for in the groundtruth and - * annotation labeled dataset. Required for creation. - * - * The number should be among the values of [AnnotationType]{@link google.cloud.datalabeling.v1beta1.AnnotationType} - * - * @property {number} evaluatedItemCount - * Output only. Count of items in groundtruth dataset included in this - * evaluation. Will be unset if annotation type is not applicable. - * - * @typedef Evaluation - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Evaluation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const Evaluation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @property {Object} boundingBoxEvaluationOptions - * This object should have the same structure as [BoundingBoxEvaluationOptions]{@link google.cloud.datalabeling.v1beta1.BoundingBoxEvaluationOptions} - * - * @typedef EvaluationConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.EvaluationConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const EvaluationConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Options regarding evaluation between bounding boxes. - * - * @property {number} iouThreshold - * Minimize IoU required to consider 2 bounding boxes are matched. - * - * @typedef BoundingBoxEvaluationOptions - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.BoundingBoxEvaluationOptions definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const BoundingBoxEvaluationOptions = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @property {Object} classificationMetrics - * This object should have the same structure as [ClassificationMetrics]{@link google.cloud.datalabeling.v1beta1.ClassificationMetrics} - * - * @property {Object} objectDetectionMetrics - * This object should have the same structure as [ObjectDetectionMetrics]{@link google.cloud.datalabeling.v1beta1.ObjectDetectionMetrics} - * - * @typedef EvaluationMetrics - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.EvaluationMetrics definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const EvaluationMetrics = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @property {Object} prCurve - * Precision-recall curve. - * - * This object should have the same structure as [PrCurve]{@link google.cloud.datalabeling.v1beta1.PrCurve} - * - * @property {Object} confusionMatrix - * This object should have the same structure as [ConfusionMatrix]{@link google.cloud.datalabeling.v1beta1.ConfusionMatrix} - * - * @typedef ClassificationMetrics - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ClassificationMetrics definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const ClassificationMetrics = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @property {Object} prCurve - * Precision-recall curve. - * - * This object should have the same structure as [PrCurve]{@link google.cloud.datalabeling.v1beta1.PrCurve} - * - * @typedef ObjectDetectionMetrics - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ObjectDetectionMetrics definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const ObjectDetectionMetrics = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @property {Object} annotationSpec - * PR curve against which annotation spec. Could be empty. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {number} areaUnderCurve - * Area under precision recall curve. - * - * @property {Object[]} confidenceMetricsEntries - * entries to draw PR graph. - * - * This object should have the same structure as [ConfidenceMetricsEntry]{@link google.cloud.datalabeling.v1beta1.ConfidenceMetricsEntry} - * - * @property {number} meanAveragePrecision - * mean average prcision of this curve. - * - * @typedef PrCurve - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.PrCurve definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const PrCurve = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * @property {number} confidenceThreshold - * Threshold used for this entry, for example, IoU threshold for bounding - * box problem, or detection threshold for classification. - * - * @property {number} recall - * Recall value. - * - * @property {number} precision - * Precision value. - * - * @property {number} f1Score - * Harmonic mean of recall and precision. - * - * @property {number} recallAt1 - * Recall value for entries with label that has highest score. - * - * @property {number} precisionAt1 - * Precision value for entries with label that has highest score. - * - * @property {number} f1ScoreAt1 - * The harmonic mean of - * recall_at1 - * and - * precision_at1. - * - * @property {number} recallAt5 - * Recall value for entries with label that has highest 5 scores. - * - * @property {number} precisionAt5 - * Precision value for entries with label that has highest 5 scores. - * - * @property {number} f1ScoreAt5 - * The harmonic mean of - * recall_at5 - * and - * precision_at5. - * - * @typedef ConfidenceMetricsEntry - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.PrCurve.ConfidenceMetricsEntry definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ - ConfidenceMetricsEntry: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; - -/** - * Confusion matrix of the model running the classification. Not applicable - * when label filtering is specified in evaluation option. - * - * @property {Object[]} row - * This object should have the same structure as [Row]{@link google.cloud.datalabeling.v1beta1.Row} - * - * @typedef ConfusionMatrix - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ConfusionMatrix definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ -const ConfusionMatrix = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * @property {Object} annotationSpec - * The predicted annotation spec. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {number} itemCount - * Number of items being predicted as this label. - * - * @typedef ConfusionMatrixEntry - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ConfusionMatrix.ConfusionMatrixEntry definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ - ConfusionMatrixEntry: { - // This is for documentation. Actual contents will be loaded by gRPC. - }, - - /** - * A row in the confusion matrix. - * - * @property {Object} annotationSpec - * the original annotation spec of this row. - * - * This object should have the same structure as [AnnotationSpec]{@link google.cloud.datalabeling.v1beta1.AnnotationSpec} - * - * @property {Object[]} entries - * Info describing predicted label distribution. - * - * This object should have the same structure as [ConfusionMatrixEntry]{@link google.cloud.datalabeling.v1beta1.ConfusionMatrixEntry} - * - * @typedef Row - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ConfusionMatrix.Row definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation.proto} - */ - Row: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_evaluation_job.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_evaluation_job.js deleted file mode 100644 index 5545e648a0e..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_evaluation_job.js +++ /dev/null @@ -1,188 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Defines an evaluation job that is triggered periodically to generate - * evaluations. - * - * @property {string} name - * Format: 'projects/{project_id}/evaluationJobs/{evaluation_job_id}' - * - * @property {string} description - * Description of the job. The description can be up to - * 25000 characters long. - * - * @property {number} state - * The number should be among the values of [State]{@link google.cloud.datalabeling.v1beta1.State} - * - * @property {string} schedule - * Describes the schedule on which the job will be executed. Minimum schedule - * unit is 1 day. - * - * The schedule can be either of the following types: - * * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) - * * English-like - * - * [schedule](https: - * //cloud.google.com/scheduler/docs/configuring/cron-job-schedules) - * - * @property {string} modelVersion - * The versioned model that is being evaluated here. - * Only one job is allowed for each model name. - * Format: 'projects/* /models/* /versions/*' - * - * @property {Object} evaluationJobConfig - * Detailed config for running this eval job. - * - * This object should have the same structure as [EvaluationJobConfig]{@link google.cloud.datalabeling.v1beta1.EvaluationJobConfig} - * - * @property {string} annotationSpecSet - * Name of the AnnotationSpecSet. - * - * @property {boolean} labelMissingGroundTruth - * If a human annotation should be requested when some data don't have ground - * truth. - * - * @property {Object[]} attempts - * Output only. Any attempts with errors happening in evaluation job runs each - * time will be recorded here incrementally. - * - * This object should have the same structure as [Attempt]{@link google.cloud.datalabeling.v1beta1.Attempt} - * - * @property {Object} createTime - * Timestamp when this evaluation job was created. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @typedef EvaluationJob - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.EvaluationJob definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation_job.proto} - */ -const EvaluationJob = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * State of the job. - * - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ - State: { - STATE_UNSPECIFIED: 0, - SCHEDULED: 1, - RUNNING: 2, - PAUSED: 3, - STOPPED: 4 - } -}; - -/** - * @property {Object} imageClassificationConfig - * This object should have the same structure as [ImageClassificationConfig]{@link google.cloud.datalabeling.v1beta1.ImageClassificationConfig} - * - * @property {Object} boundingPolyConfig - * This object should have the same structure as [BoundingPolyConfig]{@link google.cloud.datalabeling.v1beta1.BoundingPolyConfig} - * - * @property {Object} videoClassificationConfig - * This object should have the same structure as [VideoClassificationConfig]{@link google.cloud.datalabeling.v1beta1.VideoClassificationConfig} - * - * @property {Object} objectDetectionConfig - * This object should have the same structure as [ObjectDetectionConfig]{@link google.cloud.datalabeling.v1beta1.ObjectDetectionConfig} - * - * @property {Object} textClassificationConfig - * This object should have the same structure as [TextClassificationConfig]{@link google.cloud.datalabeling.v1beta1.TextClassificationConfig} - * - * @property {Object} objectTrackingConfig - * This object should have the same structure as [ObjectTrackingConfig]{@link google.cloud.datalabeling.v1beta1.ObjectTrackingConfig} - * - * @property {Object} inputConfig - * Input config for data, gcs_source in the config will be the root path for - * data. Data should be organzied chronically under that path. - * - * This object should have the same structure as [InputConfig]{@link google.cloud.datalabeling.v1beta1.InputConfig} - * - * @property {Object} evaluationConfig - * Config used to create evaluation. - * - * This object should have the same structure as [EvaluationConfig]{@link google.cloud.datalabeling.v1beta1.EvaluationConfig} - * - * @property {Object} humanAnnotationConfig - * This object should have the same structure as [HumanAnnotationConfig]{@link google.cloud.datalabeling.v1beta1.HumanAnnotationConfig} - * - * @property {Object.} bigqueryImportKeys - * Mappings between reserved keys for bigquery import and customized tensor - * names. Key is the reserved key, value is tensor name in the bigquery table. - * Different annotation type has different required key mapping. See user - * manual for more details: - * - * https: - * //docs.google.com/document/d/1bg1meMIBGY - * // 9I5QEoFoHSX6u9LsZQYBSmPt6E9SxqHZc/edit#heading=h.tfyjhxhvsqem - * - * @property {number} exampleCount - * Max number of examples to collect in each period. - * - * @property {number} exampleSamplePercentage - * Percentage of examples to collect in each period. 0.1 means 10% of total - * examples will be collected, and 0.0 means no collection. - * - * @property {Object} evaluationJobAlertConfig - * Alert config for the evaluation job. The alert will be triggered when its - * criteria is met. - * - * This object should have the same structure as [EvaluationJobAlertConfig]{@link google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig} - * - * @typedef EvaluationJobConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.EvaluationJobConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation_job.proto} - */ -const EvaluationJobConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @property {string} email - * Required. Email of the user who will be receiving the alert. - * - * @property {number} minAcceptableMeanAveragePrecision - * If a single evaluation run's aggregate mean average precision is - * lower than this threshold, the alert will be triggered. - * - * @typedef EvaluationJobAlertConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.EvaluationJobAlertConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation_job.proto} - */ -const EvaluationJobAlertConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Records a failed attempt. - * - * @property {Object} attemptTime - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object[]} partialFailures - * This object should have the same structure as [Status]{@link google.rpc.Status} - * - * @typedef Attempt - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Attempt definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/evaluation_job.proto} - */ -const Attempt = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_human_annotation_config.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_human_annotation_config.js deleted file mode 100644 index 0532654478b..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_human_annotation_config.js +++ /dev/null @@ -1,321 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Configuration for how human labeling task should be done. - * - * @property {string} instruction - * Required. Instruction resource name. - * - * @property {string} annotatedDatasetDisplayName - * Required. A human-readable name for AnnotatedDataset defined by - * users. Maximum of 64 characters - * . - * - * @property {string} annotatedDatasetDescription - * Optional. A human-readable description for AnnotatedDataset. - * The description can be up to 10000 characters long. - * - * @property {string} labelGroup - * Optional. A human-readable label used to logically group labeling tasks. - * This string must match the regular expression `[a-zA-Z\\d_-]{0,128}`. - * - * @property {string} languageCode - * 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. - * - * @property {number} replicaCount - * 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. - * - * @property {Object} questionDuration - * Optional. Maximum duration for contributors to answer a question. Default - * is 1800 seconds. - * - * This object should have the same structure as [Duration]{@link google.protobuf.Duration} - * - * @property {string[]} 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/ - * - * @property {string} userEmailAddress - * Email of the user who started the labeling task and should be notified by - * email. If empty no notification will be sent. - * - * @typedef HumanAnnotationConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.HumanAnnotationConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const HumanAnnotationConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for image classification human labeling task. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @property {boolean} allowMultiLabel - * Optional. If allow_multi_label is true, contributors are able to choose - * multiple labels for one image. - * - * @property {number} answerAggregationType - * Optional. The type of how to aggregate answers. - * - * The number should be among the values of [StringAggregationType]{@link google.cloud.datalabeling.v1beta1.StringAggregationType} - * - * @typedef ImageClassificationConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ImageClassificationConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const ImageClassificationConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for image bounding poly (and bounding box) human labeling task. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @property {string} instructionMessage - * Optional. Instruction message showed on contributors UI. - * - * @typedef BoundingPolyConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.BoundingPolyConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const BoundingPolyConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for image polyline human labeling task. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @property {string} instructionMessage - * Optional. Instruction message showed on contributors UI. - * - * @typedef PolylineConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.PolylineConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const PolylineConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for image segmentation - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. format: - * projects/{project_id}/annotationSpecSets/{annotation_spec_set_id} - * - * @property {string} instructionMessage - * Instruction message showed on labelers UI. - * - * @typedef SegmentationConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SegmentationConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const SegmentationConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * 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. - * - * @property {Object[]} 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. - * - * This object should have the same structure as [AnnotationSpecSetConfig]{@link google.cloud.datalabeling.v1beta1.AnnotationSpecSetConfig} - * - * @property {boolean} applyShotDetection - * Optional. Option to apply shot detection on the video. - * - * @typedef VideoClassificationConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoClassificationConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const VideoClassificationConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. - - /** - * Annotation spec set with the setting of allowing multi labels or not. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @property {boolean} allowMultiLabel - * Optional. If allow_multi_label is true, contributors are able to - * choose multiple labels from one annotation spec set. - * - * @typedef AnnotationSpecSetConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.VideoClassificationConfig.AnnotationSpecSetConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ - AnnotationSpecSetConfig: { - // This is for documentation. Actual contents will be loaded by gRPC. - } -}; - -/** - * 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. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @property {number} extractionFrameRate - * Required. Number of frames per second to be extracted from the video. - * - * @typedef ObjectDetectionConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ObjectDetectionConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const ObjectDetectionConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for video object tracking human labeling task. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @typedef ObjectTrackingConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.ObjectTrackingConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const ObjectTrackingConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for video event human labeling task. - * - * @property {string[]} 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. - * - * @typedef EventConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.EventConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const EventConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for text classification human labeling task. - * - * @property {boolean} allowMultiLabel - * Optional. If allow_multi_label is true, contributors are able to choose - * multiple labels for one text segment. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @property {Object} sentimentConfig - * Optional. Configs for sentiment selection. - * - * This object should have the same structure as [SentimentConfig]{@link google.cloud.datalabeling.v1beta1.SentimentConfig} - * - * @typedef TextClassificationConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TextClassificationConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const TextClassificationConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for setting up sentiments. - * - * @property {boolean} enableLabelSentimentSelection - * If set to true, contributors will have the option to select sentiment of - * the label they selected, to mark it as negative or positive label. Default - * is false. - * - * @typedef SentimentConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.SentimentConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const SentimentConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Config for text entity extraction human labeling task. - * - * @property {string} annotationSpecSet - * Required. Annotation spec set resource name. - * - * @typedef TextEntityExtractionConfig - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.TextEntityExtractionConfig definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/human_annotation_config.proto} - */ -const TextEntityExtractionConfig = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * @enum {number} - * @memberof google.cloud.datalabeling.v1beta1 - */ -const StringAggregationType = { - STRING_AGGREGATION_TYPE_UNSPECIFIED: 0, - - /** - * Majority vote to aggregate answers. - */ - MAJORITY_VOTE: 1, - - /** - * Unanimous answers will be adopted. - */ - UNANIMOUS_VOTE: 2, - - /** - * Preserve all answers by crowd compute. - */ - NO_AGGREGATION: 3 -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_instruction.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_instruction.js deleted file mode 100644 index 6e0e7c8efbf..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/cloud/datalabeling/v1beta1/doc_instruction.js +++ /dev/null @@ -1,107 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * Instruction of how to perform the labeling task for human operators. - * Currently two types of instruction are supported - CSV file and PDF. - * One of the two types instruction must be provided. - * CSV file is only supported for image classification task. Instructions for - * other task should be provided as PDF. - * For image classification, CSV and PDF can be provided at the same time. - * - * @property {string} name - * Output only. Instruction resource name, format: - * projects/{project_id}/instructions/{instruction_id} - * - * @property {string} displayName - * Required. The display name of the instruction. Maximum of 64 characters. - * - * @property {string} description - * Optional. User-provided description of the instruction. - * The description can be up to 10000 characters long. - * - * @property {Object} createTime - * Output only. Creation time of instruction. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {Object} updateTime - * Output only. Last update time of instruction. - * - * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp} - * - * @property {number} dataType - * Required. The data type of this instruction. - * - * The number should be among the values of [DataType]{@link google.cloud.datalabeling.v1beta1.DataType} - * - * @property {Object} csvInstruction - * One of CSV or PDF instruction is required. - * Instruction from a CSV file, such as for classification task. - * The CSV file should have exact two columns, in the following format: - * - * * The first column is labeled data, such as an image reference, text. - * * The second column is comma separated labels associated with data. - * - * This object should have the same structure as [CsvInstruction]{@link google.cloud.datalabeling.v1beta1.CsvInstruction} - * - * @property {Object} pdfInstruction - * One of CSV or PDF instruction is required. - * Instruction from a PDF document. The PDF should be in a Cloud Storage - * bucket. - * - * This object should have the same structure as [PdfInstruction]{@link google.cloud.datalabeling.v1beta1.PdfInstruction} - * - * @property {string[]} blockingResources - * Output only. The names of any related resources that are blocking changes - * to the instruction. - * - * @typedef Instruction - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.Instruction definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/instruction.proto} - */ -const Instruction = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Instruction from a CSV file. - * - * @property {string} gcsFileUri - * CSV file for the instruction. Only gcs path is allowed. - * - * @typedef CsvInstruction - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.CsvInstruction definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/instruction.proto} - */ -const CsvInstruction = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; - -/** - * Instruction from a PDF file. - * - * @property {string} gcsFileUri - * PDF file for the instruction. Only gcs path is allowed. - * - * @typedef PdfInstruction - * @memberof google.cloud.datalabeling.v1beta1 - * @see [google.cloud.datalabeling.v1beta1.PdfInstruction definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/datalabeling/v1beta1/instruction.proto} - */ -const PdfInstruction = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/longrunning/doc_operations.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/longrunning/doc_operations.js deleted file mode 100644 index 5aa806fd340..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/longrunning/doc_operations.js +++ /dev/null @@ -1,63 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * This resource represents a long-running operation that is the result of a - * network API call. - * - * @property {string} name - * 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}`. - * - * @property {Object} 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. - * - * This object should have the same structure as [Any]{@link google.protobuf.Any} - * - * @property {boolean} done - * 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. - * - * @property {Object} error - * The error result of the operation in case of failure or cancellation. - * - * This object should have the same structure as [Status]{@link google.rpc.Status} - * - * @property {Object} 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`. - * - * This object should have the same structure as [Any]{@link google.protobuf.Any} - * - * @typedef Operation - * @memberof google.longrunning - * @see [google.longrunning.Operation definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto} - */ -const Operation = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_any.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_any.js deleted file mode 100644 index cdd2fc80e49..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_any.js +++ /dev/null @@ -1,137 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * `Any` contains an arbitrary serialized protocol buffer message along with a - * URL that describes the type of the serialized message. - * - * Protobuf library provides support to pack/unpack Any values in the form - * of utility functions or additional generated methods of the Any type. - * - * Example 1: Pack and unpack a message in C++. - * - * Foo foo = ...; - * Any any; - * any.PackFrom(foo); - * ... - * if (any.UnpackTo(&foo)) { - * ... - * } - * - * Example 2: Pack and unpack a message in Java. - * - * Foo foo = ...; - * Any any = Any.pack(foo); - * ... - * if (any.is(Foo.class)) { - * foo = any.unpack(Foo.class); - * } - * - * Example 3: Pack and unpack a message in Python. - * - * foo = Foo(...) - * any = Any() - * any.Pack(foo) - * ... - * if any.Is(Foo.DESCRIPTOR): - * any.Unpack(foo) - * ... - * - * Example 4: Pack and unpack a message in Go - * - * foo := &pb.Foo{...} - * any, err := ptypes.MarshalAny(foo) - * ... - * foo := &pb.Foo{} - * if err := ptypes.UnmarshalAny(any, foo); err != nil { - * ... - * } - * - * The pack methods provided by protobuf library will by default use - * 'type.googleapis.com/full.type.name' as the type URL and the unpack - * methods only use the fully qualified type name after the last '/' - * in the type URL, for example "foo.bar.com/x/y.z" will yield type - * name "y.z". - * - * - * # JSON - * - * The JSON representation of an `Any` value uses the regular - * representation of the deserialized, embedded message, with an - * additional field `@type` which contains the type URL. Example: - * - * package google.profile; - * message Person { - * string first_name = 1; - * string last_name = 2; - * } - * - * { - * "@type": "type.googleapis.com/google.profile.Person", - * "firstName": , - * "lastName": - * } - * - * If the embedded message type is well-known and has a custom JSON - * representation, that representation will be embedded adding a field - * `value` which holds the custom JSON in addition to the `@type` - * field. Example (for message google.protobuf.Duration): - * - * { - * "@type": "type.googleapis.com/google.protobuf.Duration", - * "value": "1.212s" - * } - * - * @property {string} typeUrl - * A URL/resource name that uniquely identifies the type of the serialized - * protocol buffer message. This string must contain at least - * one "/" character. The last segment of the URL's path must represent - * the fully qualified name of the type (as in - * `path/google.protobuf.Duration`). The name should be in a canonical form - * (e.g., leading "." is not accepted). - * - * In practice, teams usually precompile into the binary all types that they - * expect it to use in the context of Any. However, for URLs which use the - * scheme `http`, `https`, or no scheme, one can optionally set up a type - * server that maps type URLs to message definitions as follows: - * - * * If no scheme is provided, `https` is assumed. - * * An HTTP GET on the URL must yield a google.protobuf.Type - * value in binary format, or produce an error. - * * Applications are allowed to cache lookup results based on the - * URL, or have them precompiled into a binary to avoid any - * lookup. Therefore, binary compatibility needs to be preserved - * on changes to types. (Use versioned type names to manage - * breaking changes.) - * - * Note: this functionality is not currently available in the official - * protobuf release, and it is not used for type URLs beginning with - * type.googleapis.com. - * - * Schemes other than `http`, `https` (or the empty scheme) might be - * used with implementation specific semantics. - * - * @property {Buffer} value - * Must be a valid serialized protocol buffer of the above specified type. - * - * @typedef Any - * @memberof google.protobuf - * @see [google.protobuf.Any definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/any.proto} - */ -const Any = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_duration.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_duration.js deleted file mode 100644 index 1275f8f4d13..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_duration.js +++ /dev/null @@ -1,97 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * A Duration represents a signed, fixed-length span of time represented - * as a count of seconds and fractions of seconds at nanosecond - * resolution. It is independent of any calendar and concepts like "day" - * or "month". It is related to Timestamp in that the difference between - * two Timestamp values is a Duration and it can be added or subtracted - * from a Timestamp. Range is approximately +-10,000 years. - * - * # Examples - * - * Example 1: Compute Duration from two Timestamps in pseudo code. - * - * Timestamp start = ...; - * Timestamp end = ...; - * Duration duration = ...; - * - * duration.seconds = end.seconds - start.seconds; - * duration.nanos = end.nanos - start.nanos; - * - * if (duration.seconds < 0 && duration.nanos > 0) { - * duration.seconds += 1; - * duration.nanos -= 1000000000; - * } else if (durations.seconds > 0 && duration.nanos < 0) { - * duration.seconds -= 1; - * duration.nanos += 1000000000; - * } - * - * Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - * - * Timestamp start = ...; - * Duration duration = ...; - * Timestamp end = ...; - * - * end.seconds = start.seconds + duration.seconds; - * end.nanos = start.nanos + duration.nanos; - * - * if (end.nanos < 0) { - * end.seconds -= 1; - * end.nanos += 1000000000; - * } else if (end.nanos >= 1000000000) { - * end.seconds += 1; - * end.nanos -= 1000000000; - * } - * - * Example 3: Compute Duration from datetime.timedelta in Python. - * - * td = datetime.timedelta(days=3, minutes=10) - * duration = Duration() - * duration.FromTimedelta(td) - * - * # JSON Mapping - * - * In JSON format, the Duration type is encoded as a string rather than an - * object, where the string ends in the suffix "s" (indicating seconds) and - * is preceded by the number of seconds, with nanoseconds expressed as - * fractional seconds. For example, 3 seconds with 0 nanoseconds should be - * encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should - * be expressed in JSON format as "3.000000001s", and 3 seconds and 1 - * microsecond should be expressed in JSON format as "3.000001s". - * - * @property {number} seconds - * Signed seconds of the span of time. Must be from -315,576,000,000 - * to +315,576,000,000 inclusive. Note: these bounds are computed from: - * 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - * - * @property {number} nanos - * Signed fractions of a second at nanosecond resolution of the span - * of time. Durations less than one second are represented with a 0 - * `seconds` field and a positive or negative `nanos` field. For durations - * of one second or more, a non-zero value for the `nanos` field must be - * of the same sign as the `seconds` field. Must be from -999,999,999 - * to +999,999,999 inclusive. - * - * @typedef Duration - * @memberof google.protobuf - * @see [google.protobuf.Duration definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/duration.proto} - */ -const Duration = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_empty.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_empty.js deleted file mode 100644 index 0b446dd9ce4..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_empty.js +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * 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 `{}`. - * @typedef Empty - * @memberof google.protobuf - * @see [google.protobuf.Empty definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/empty.proto} - */ -const Empty = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_field_mask.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_field_mask.js deleted file mode 100644 index 011207b8626..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_field_mask.js +++ /dev/null @@ -1,228 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * `FieldMask` represents a set of symbolic field paths, for example: - * - * paths: "f.a" - * paths: "f.b.d" - * - * Here `f` represents a field in some root message, `a` and `b` - * fields in the message found in `f`, and `d` a field found in the - * message in `f.b`. - * - * Field masks are used to specify a subset of fields that should be - * returned by a get operation or modified by an update operation. - * Field masks also have a custom JSON encoding (see below). - * - * # Field Masks in Projections - * - * When used in the context of a projection, a response message or - * sub-message is filtered by the API to only contain those fields as - * specified in the mask. For example, if the mask in the previous - * example is applied to a response message as follows: - * - * f { - * a : 22 - * b { - * d : 1 - * x : 2 - * } - * y : 13 - * } - * z: 8 - * - * The result will not contain specific values for fields x,y and z - * (their value will be set to the default, and omitted in proto text - * output): - * - * - * f { - * a : 22 - * b { - * d : 1 - * } - * } - * - * A repeated field is not allowed except at the last position of a - * paths string. - * - * If a FieldMask object is not present in a get operation, the - * operation applies to all fields (as if a FieldMask of all fields - * had been specified). - * - * Note that a field mask does not necessarily apply to the - * top-level response message. In case of a REST get operation, the - * field mask applies directly to the response, but in case of a REST - * list operation, the mask instead applies to each individual message - * in the returned resource list. In case of a REST custom method, - * other definitions may be used. Where the mask applies will be - * clearly documented together with its declaration in the API. In - * any case, the effect on the returned resource/resources is required - * behavior for APIs. - * - * # Field Masks in Update Operations - * - * A field mask in update operations specifies which fields of the - * targeted resource are going to be updated. The API is required - * to only change the values of the fields as specified in the mask - * and leave the others untouched. If a resource is passed in to - * describe the updated values, the API ignores the values of all - * fields not covered by the mask. - * - * If a repeated field is specified for an update operation, new values will - * be appended to the existing repeated field in the target resource. Note that - * a repeated field is only allowed in the last position of a `paths` string. - * - * If a sub-message is specified in the last position of the field mask for an - * update operation, then new value will be merged into the existing sub-message - * in the target resource. - * - * For example, given the target message: - * - * f { - * b { - * d: 1 - * x: 2 - * } - * c: [1] - * } - * - * And an update message: - * - * f { - * b { - * d: 10 - * } - * c: [2] - * } - * - * then if the field mask is: - * - * paths: ["f.b", "f.c"] - * - * then the result will be: - * - * f { - * b { - * d: 10 - * x: 2 - * } - * c: [1, 2] - * } - * - * An implementation may provide options to override this default behavior for - * repeated and message fields. - * - * In order to reset a field's value to the default, the field must - * be in the mask and set to the default value in the provided resource. - * Hence, in order to reset all fields of a resource, provide a default - * instance of the resource and set all fields in the mask, or do - * not provide a mask as described below. - * - * If a field mask is not present on update, the operation applies to - * all fields (as if a field mask of all fields has been specified). - * Note that in the presence of schema evolution, this may mean that - * fields the client does not know and has therefore not filled into - * the request will be reset to their default. If this is unwanted - * behavior, a specific service may require a client to always specify - * a field mask, producing an error if not. - * - * As with get operations, the location of the resource which - * describes the updated values in the request message depends on the - * operation kind. In any case, the effect of the field mask is - * required to be honored by the API. - * - * ## Considerations for HTTP REST - * - * The HTTP kind of an update operation which uses a field mask must - * be set to PATCH instead of PUT in order to satisfy HTTP semantics - * (PUT must only be used for full updates). - * - * # JSON Encoding of Field Masks - * - * In JSON, a field mask is encoded as a single string where paths are - * separated by a comma. Fields name in each path are converted - * to/from lower-camel naming conventions. - * - * As an example, consider the following message declarations: - * - * message Profile { - * User user = 1; - * Photo photo = 2; - * } - * message User { - * string display_name = 1; - * string address = 2; - * } - * - * In proto a field mask for `Profile` may look as such: - * - * mask { - * paths: "user.display_name" - * paths: "photo" - * } - * - * In JSON, the same mask is represented as below: - * - * { - * mask: "user.displayName,photo" - * } - * - * # Field Masks and Oneof Fields - * - * Field masks treat fields in oneofs just as regular fields. Consider the - * following message: - * - * message SampleMessage { - * oneof test_oneof { - * string name = 4; - * SubMessage sub_message = 9; - * } - * } - * - * The field mask can be: - * - * mask { - * paths: "name" - * } - * - * Or: - * - * mask { - * paths: "sub_message" - * } - * - * Note that oneof type names ("test_oneof" in this case) cannot be used in - * paths. - * - * ## Field Mask Verification - * - * The implementation of any API method which has a FieldMask type field in the - * request should verify the included field paths, and return an - * `INVALID_ARGUMENT` error if any path is duplicated or unmappable. - * - * @property {string[]} paths - * The set of field mask paths. - * - * @typedef FieldMask - * @memberof google.protobuf - * @see [google.protobuf.FieldMask definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/field_mask.proto} - */ -const FieldMask = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_timestamp.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_timestamp.js deleted file mode 100644 index c457acc0c7d..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/protobuf/doc_timestamp.js +++ /dev/null @@ -1,117 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * A Timestamp represents a point in time independent of any time zone or local - * calendar, encoded as a count of seconds and fractions of seconds at - * nanosecond resolution. The count is relative to an epoch at UTC midnight on - * January 1, 1970, in the proleptic Gregorian calendar which extends the - * Gregorian calendar backwards to year one. - * - * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - * second table is needed for interpretation, using a [24-hour linear - * smear](https://developers.google.com/time/smear). - * - * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - * restricting to that range, we ensure that we can convert to and from [RFC - * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. - * - * # Examples - * - * Example 1: Compute Timestamp from POSIX `time()`. - * - * Timestamp timestamp; - * timestamp.set_seconds(time(NULL)); - * timestamp.set_nanos(0); - * - * Example 2: Compute Timestamp from POSIX `gettimeofday()`. - * - * struct timeval tv; - * gettimeofday(&tv, NULL); - * - * Timestamp timestamp; - * timestamp.set_seconds(tv.tv_sec); - * timestamp.set_nanos(tv.tv_usec * 1000); - * - * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - * - * FILETIME ft; - * GetSystemTimeAsFileTime(&ft); - * UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; - * - * // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z - * // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. - * Timestamp timestamp; - * timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - * timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - * - * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - * - * long millis = System.currentTimeMillis(); - * - * Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) - * .setNanos((int) ((millis % 1000) * 1000000)).build(); - * - * - * Example 5: Compute Timestamp from current time in Python. - * - * timestamp = Timestamp() - * timestamp.GetCurrentTime() - * - * # JSON Mapping - * - * In JSON format, the Timestamp type is encoded as a string in the - * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the - * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" - * where {year} is always expressed using four digits while {month}, {day}, - * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional - * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), - * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone - * is required. A proto3 JSON serializer should always use UTC (as indicated by - * "Z") when printing the Timestamp type and a proto3 JSON parser should be - * able to accept both UTC and other timezones (as indicated by an offset). - * - * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past - * 01:30 UTC on January 15, 2017. - * - * In JavaScript, one can convert a Date object to this format using the - * standard - * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - * method. In Python, a standard `datetime.datetime` object can be converted - * to this format using - * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with - * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use - * the Joda Time's [`ISODateTimeFormat.dateTime()`](https://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D) to obtain a formatter capable of generating timestamps in this format. - * - * @property {number} seconds - * Represents seconds of UTC time since Unix epoch - * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - * 9999-12-31T23:59:59Z inclusive. - * - * @property {number} nanos - * Non-negative fractions of a second at nanosecond resolution. Negative - * second values with fractions must still have non-negative nanos values - * that count forward in time. Must be from 0 to 999,999,999 - * inclusive. - * - * @typedef Timestamp - * @memberof google.protobuf - * @see [google.protobuf.Timestamp definition in proto format]{@link https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto} - */ -const Timestamp = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/rpc/doc_status.js b/packages/google-cloud-datalabeling/src/v1beta1/doc/google/rpc/doc_status.js deleted file mode 100644 index 432ab6bb928..00000000000 --- a/packages/google-cloud-datalabeling/src/v1beta1/doc/google/rpc/doc_status.js +++ /dev/null @@ -1,95 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// https://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -// Note: this file is purely for documentation. Any contents are not expected -// to be loaded as the JS file. - -/** - * 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). The error model is designed to be: - * - * - Simple to use and understand for most users - * - Flexible enough to meet unexpected needs - * - * # Overview - * - * The `Status` message contains three pieces of data: error code, error - * message, and error details. The error code should be an enum value of - * google.rpc.Code, but it may accept additional error codes - * if needed. The error message should be a developer-facing English message - * that helps developers *understand* and *resolve* the error. If a localized - * user-facing error message is needed, put the localized message in the error - * details or localize it in the client. The optional error details may contain - * arbitrary information about the error. There is a predefined set of error - * detail types in the package `google.rpc` that can be used for common error - * conditions. - * - * # Language mapping - * - * The `Status` message is the logical representation of the error model, but it - * is not necessarily the actual wire format. When the `Status` message is - * exposed in different client libraries and different wire protocols, it can be - * mapped differently. For example, it will likely be mapped to some exceptions - * in Java, but more likely mapped to some error codes in C. - * - * # Other uses - * - * The error model and the `Status` message can be used in a variety of - * environments, either with or without APIs, to provide a - * consistent developer experience across different environments. - * - * Example uses of this error model include: - * - * - Partial errors. If a service needs to return partial errors to the client, - * it may embed the `Status` in the normal response to indicate the partial - * errors. - * - * - Workflow errors. A typical workflow has multiple steps. Each step may - * have a `Status` message for error reporting. - * - * - Batch operations. If a client uses batch request and batch response, the - * `Status` message should be used directly inside batch response, one for - * each error sub-response. - * - * - Asynchronous operations. If an API call embeds asynchronous operation - * results in its response, the status of those operations should be - * represented directly using the `Status` message. - * - * - Logging. If some API errors are stored in logs, the message `Status` could - * be used directly after any stripping needed for security/privacy reasons. - * - * @property {number} code - * The status code, which should be an enum value of - * google.rpc.Code. - * - * @property {string} message - * 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. - * - * @property {Object[]} details - * A list of messages that carry the error details. There is a common set of - * message types for APIs to use. - * - * This object should have the same structure as [Any]{@link google.protobuf.Any} - * - * @typedef Status - * @memberof google.rpc - * @see [google.rpc.Status definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto} - */ -const Status = { - // This is for documentation. Actual contents will be loaded by gRPC. -}; \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/synth.metadata b/packages/google-cloud-datalabeling/synth.metadata index a24791c82fc..9f9391be5c5 100644 --- a/packages/google-cloud-datalabeling/synth.metadata +++ b/packages/google-cloud-datalabeling/synth.metadata @@ -1,12 +1,26 @@ { - "updateTime": "2020-04-11T00:08:22.182896Z", "sources": [ + { + "git": { + "name": ".", + "remote": "git@github.com:googleapis/nodejs-datalabeling.git", + "sha": "433e166dd670d8d078e02d6ea7d5354508287ba6" + } + }, + { + "git": { + "name": "googleapis", + "remote": "https://github.com/googleapis/googleapis.git", + "sha": "26523a96798ce1a6caa1b3c912119059cfcc98a7", + "internalRef": "306320014" + } + }, { "git": { "name": "synthtool", "remote": "https://github.com/googleapis/synthtool.git", - "sha": "6f32150677c9784f3c3a7e1949472bd29c9d72c5", - "log": "6f32150677c9784f3c3a7e1949472bd29c9d72c5\nfix: installs test_utils from its common repo (#480)\n\n\n74ce986d3b5431eb66985e9a00c4eb45295a4020\nfix: stop recording update_time in synth.metadata (#478)\n\n\n7f8e62aa3edd225f76347a16f92e400661fdfb52\nchore(java): release-please only updates non maven versions in README (#476)\n\nPrevent release-please and synthtool from fighting over the released library version. Synthtool updates the install snippets from the samples pom.xml files so the bots fight if they are temporarily out of sync after a release.\nc7e0e517d7f46f77bebd27da2e5afcaa6eee7e25\nbuild(java): fix nightly integration test config to run integrations (#465)\n\nThis was only running the units.\nbd69a2aa7b70875f3c988e269706b22fefbef40e\nbuild(java): fix retry_with_backoff when -e option set (#475)\n\n\nd9b173c427bfa0c6cca818233562e7e8841a357c\nfix: record version of working repo in synth.metadata (#473)\n\nPartial revert of b37cf74d12e9a42b9de9e61a4f26133d7cd9c168.\nf73a541770d95a609e5be6bf6b3b220d17cefcbe\nfeat(discogapic): allow local discovery-artifact-manager (#474)\n\n\n8cf0f5d93a70c3dcb0b4999d3152c46d4d9264bf\ndoc: describe the Autosynth & Synthtool protocol (#472)\n\n* doc: describe the Autosynth & Synthtool protocol\n\n* Accommodate review comments.\n980baaa738a1ad8fa02b4fdbd56be075ee77ece5\nfix: pin sphinx to <3.0.0 as new version causes new error (#471)\n\nThe error `toctree contains reference to document changlelog that doesn't have a title: no link will be generated` occurs as of 3.0.0. Pinning to 2.x until we address the docs build issue.\n\nTowards #470\n\nI did this manually for python-datastore https://github.com/googleapis/python-datastore/pull/22\n928b2998ac5023e7c7e254ab935f9ef022455aad\nchore(deps): update dependency com.google.cloud.samples:shared-configuration to v1.0.15 (#466)\n\nCo-authored-by: Jeffrey Rennie \n188f1b1d53181f739b98f8aa5d40cfe99eb90c47\nfix: allow local and external deps to be specified (#469)\n\nModify noxfile.py to allow local and external dependencies for\nsystem tests to be specified.\n" + "sha": "3df869dd6eb546ef13beeb7a9efa6ee0226afafd", + "log": "3df869dd6eb546ef13beeb7a9efa6ee0226afafd\nci: add dependency list completeness check (#490)\n\n\n682c0c37d1054966ca662a44259e96cc7aea4413\nbuild(nodejs): update lint ignore rules (#488)\n\n\n97c7ccfdceb927db1cbe6f3bb09616aa02bafd89\ndoc: document context-aware commit flags (#481)\n\nAlso, delete obsolete blurb about cleaning up old, dead files.\n\nCo-authored-by: Jeff Ching \n8eff3790f88b50706a0c4b6a20b385f24e9ac4e7\nfeat: common postprocessing for node libraries (#485)\n\nCo-authored-by: Justin Beckwith \n21c3b57ae54ae9db6a3a6b48b31c970c6ab56f19\nbuild(nodejs): remove unused codecov config (#486)\n\n\n" } } ], diff --git a/packages/google-cloud-datalabeling/synth.py b/packages/google-cloud-datalabeling/synth.py index db00cd645c8..3ff0c26a1ec 100644 --- a/packages/google-cloud-datalabeling/synth.py +++ b/packages/google-cloud-datalabeling/synth.py @@ -23,7 +23,6 @@ AUTOSYNTH_MULTIPLE_COMMITS = True - # Run the gapic generator gapic = gcp.GAPICMicrogenerator() versions = ['v1beta1'] @@ -33,7 +32,7 @@ generator_args={ "grpc-service-config": f"google/cloud/datalabeling/{version}/datalabeling_grpc_service_config.json", "package-name": f"@google-cloud/datalabeling", - "main-service": f"datalabeling" + "main-service": f"datalabeling" }, proto_path=f'/google/cloud/datalabeling/{version}', extra_proto_files=['google/cloud/common_resources.proto'], @@ -47,5 +46,5 @@ # Node.js specific cleanup subprocess.run(['npm', 'install']) -subprocess.run(['npm', 'run', 'lint']) +subprocess.run(['npm', 'run', 'fix']) subprocess.run(['npx', 'compileProtos', 'src']) diff --git a/packages/google-cloud-datalabeling/system-test/install.ts b/packages/google-cloud-datalabeling/system-test/install.ts index c4d80e9c0c8..4c1ba3eb79a 100644 --- a/packages/google-cloud-datalabeling/system-test/install.ts +++ b/packages/google-cloud-datalabeling/system-test/install.ts @@ -21,7 +21,7 @@ import {readFileSync} from 'fs'; import {describe, it} from 'mocha'; describe('typescript consumer tests', () => { - it('should have correct type signature for typescript users', async function() { + it('should have correct type signature for typescript users', async function () { this.timeout(300000); const options = { packageDir: process.cwd(), // path to your module. @@ -35,7 +35,7 @@ describe('typescript consumer tests', () => { await packNTest(options); // will throw upon error. }); - it('should have correct type signature for javascript users', async function() { + it('should have correct type signature for javascript users', async function () { this.timeout(300000); const options = { packageDir: process.cwd(), // path to your module. diff --git a/packages/google-cloud-datalabeling/tslint.json b/packages/google-cloud-datalabeling/tslint.json deleted file mode 100644 index 617dc975bae..00000000000 --- a/packages/google-cloud-datalabeling/tslint.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "extends": "gts/tslint.json" -}