1// Copyright 2021 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.automl.v1;
18
19import "google/api/resource.proto";
20import "google/cloud/automl/v1/image.proto";
21import "google/cloud/automl/v1/text.proto";
22import "google/cloud/automl/v1/translation.proto";
23import "google/protobuf/timestamp.proto";
24
25option csharp_namespace = "Google.Cloud.AutoML.V1";
26option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
27option java_multiple_files = true;
28option java_package = "com.google.cloud.automl.v1";
29option php_namespace = "Google\\Cloud\\AutoMl\\V1";
30option ruby_package = "Google::Cloud::AutoML::V1";
31
32// A workspace for solving a single, particular machine learning (ML) problem.
33// A workspace contains examples that may be annotated.
34message Dataset {
35  option (google.api.resource) = {
36    type: "automl.googleapis.com/Dataset"
37    pattern: "projects/{project}/locations/{location}/datasets/{dataset}"
38  };
39
40  // Required.
41  // The dataset metadata that is specific to the problem type.
42  oneof dataset_metadata {
43    // Metadata for a dataset used for translation.
44    TranslationDatasetMetadata translation_dataset_metadata = 23;
45
46    // Metadata for a dataset used for image classification.
47    ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24;
48
49    // Metadata for a dataset used for text classification.
50    TextClassificationDatasetMetadata text_classification_dataset_metadata = 25;
51
52    // Metadata for a dataset used for image object detection.
53    ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26;
54
55    // Metadata for a dataset used for text extraction.
56    TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28;
57
58    // Metadata for a dataset used for text sentiment.
59    TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30;
60  }
61
62  // Output only. The resource name of the dataset.
63  // Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`
64  string name = 1;
65
66  // Required. The name of the dataset to show in the interface. The name can be
67  // up to 32 characters long and can consist only of ASCII Latin letters A-Z
68  // and a-z, underscores
69  // (_), and ASCII digits 0-9.
70  string display_name = 2;
71
72  // User-provided description of the dataset. The description can be up to
73  // 25000 characters long.
74  string description = 3;
75
76  // Output only. The number of examples in the dataset.
77  int32 example_count = 21;
78
79  // Output only. Timestamp when this dataset was created.
80  google.protobuf.Timestamp create_time = 14;
81
82  // Used to perform consistent read-modify-write updates. If not set, a blind
83  // "overwrite" update happens.
84  string etag = 17;
85
86  // Optional. The labels with user-defined metadata to organize your dataset.
87  //
88  // Label keys and values can be no longer than 64 characters
89  // (Unicode codepoints), can only contain lowercase letters, numeric
90  // characters, underscores and dashes. International characters are allowed.
91  // Label values are optional. Label keys must start with a letter.
92  //
93  // See https://goo.gl/xmQnxf for more information on and examples of labels.
94  map<string, string> labels = 39;
95}
96