1// Copyright 2020 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.v1beta1;
18
19import "google/api/resource.proto";
20import "google/cloud/automl/v1beta1/image.proto";
21import "google/cloud/automl/v1beta1/tables.proto";
22import "google/cloud/automl/v1beta1/text.proto";
23import "google/cloud/automl/v1beta1/translation.proto";
24import "google/cloud/automl/v1beta1/video.proto";
25import "google/protobuf/timestamp.proto";
26
27option go_package = "cloud.google.com/go/automl/apiv1beta1/automlpb;automlpb";
28option java_multiple_files = true;
29option java_package = "com.google.cloud.automl.v1beta1";
30option php_namespace = "Google\\Cloud\\AutoMl\\V1beta1";
31option ruby_package = "Google::Cloud::AutoML::V1beta1";
32
33// A workspace for solving a single, particular machine learning (ML) problem.
34// A workspace contains examples that may be annotated.
35message Dataset {
36  option (google.api.resource) = {
37    type: "automl.googleapis.com/Dataset"
38    pattern: "projects/{project}/locations/{location}/datasets/{dataset}"
39  };
40
41  // Required.
42  // The dataset metadata that is specific to the problem type.
43  oneof dataset_metadata {
44    // Metadata for a dataset used for translation.
45    TranslationDatasetMetadata translation_dataset_metadata = 23;
46
47    // Metadata for a dataset used for image classification.
48    ImageClassificationDatasetMetadata image_classification_dataset_metadata = 24;
49
50    // Metadata for a dataset used for text classification.
51    TextClassificationDatasetMetadata text_classification_dataset_metadata = 25;
52
53    // Metadata for a dataset used for image object detection.
54    ImageObjectDetectionDatasetMetadata image_object_detection_dataset_metadata = 26;
55
56    // Metadata for a dataset used for video classification.
57    VideoClassificationDatasetMetadata video_classification_dataset_metadata = 31;
58
59    // Metadata for a dataset used for video object tracking.
60    VideoObjectTrackingDatasetMetadata video_object_tracking_dataset_metadata = 29;
61
62    // Metadata for a dataset used for text extraction.
63    TextExtractionDatasetMetadata text_extraction_dataset_metadata = 28;
64
65    // Metadata for a dataset used for text sentiment.
66    TextSentimentDatasetMetadata text_sentiment_dataset_metadata = 30;
67
68    // Metadata for a dataset used for Tables.
69    TablesDatasetMetadata tables_dataset_metadata = 33;
70  }
71
72  // Output only. The resource name of the dataset.
73  // Form: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`
74  string name = 1;
75
76  // Required. The name of the dataset to show in the interface. The name can be
77  // up to 32 characters long and can consist only of ASCII Latin letters A-Z
78  // and a-z, underscores
79  // (_), and ASCII digits 0-9.
80  string display_name = 2;
81
82  // User-provided description of the dataset. The description can be up to
83  // 25000 characters long.
84  string description = 3;
85
86  // Output only. The number of examples in the dataset.
87  int32 example_count = 21;
88
89  // Output only. Timestamp when this dataset was created.
90  google.protobuf.Timestamp create_time = 14;
91
92  // Used to perform consistent read-modify-write updates. If not set, a blind
93  // "overwrite" update happens.
94  string etag = 17;
95}
96