automl/v1beta1 publish proto updates

PiperOrigin-RevId: 298484782
This commit is contained in:
Google APIs 2020-03-02 17:12:42 -08:00 committed by Copybara-Service
parent 6de6e938b7
commit 4a180bfff8
31 changed files with 711 additions and 226 deletions

View File

@ -44,10 +44,13 @@ proto_library(
deps = [
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
"@com_google_protobuf//:any_proto",
"@com_google_protobuf//:duration_proto",
"@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:struct_proto",
"@com_google_protobuf//:timestamp_proto",
@ -90,7 +93,7 @@ java_gapic_library(
src = ":automl_proto_with_info",
gapic_yaml = "automl_gapic.yaml",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
test_deps = [
":automl_java_grpc",
],
@ -148,7 +151,7 @@ go_gapic_library(
gapic_yaml = "automl_gapic.yaml",
importpath = "cloud.google.com/go/automl/apiv1beta1",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
deps = [
":automl_go_proto",
"//google/longrunning:longrunning_go_gapic",
@ -196,10 +199,13 @@ moved_proto_library(
deps = [
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
"@com_google_protobuf//:any_proto",
"@com_google_protobuf//:duration_proto",
"@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:struct_proto",
"@com_google_protobuf//:timestamp_proto",
@ -223,7 +229,7 @@ py_gapic_library(
src = ":automl_proto_with_info",
gapic_yaml = "automl_gapic.yaml",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
deps = [
":automl_py_grpc",
":automl_py_proto",
@ -267,7 +273,7 @@ php_gapic_library(
src = ":automl_proto_with_info",
gapic_yaml = "automl_gapic.yaml",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
deps = [
":automl_php_grpc",
":automl_php_proto",
@ -298,7 +304,7 @@ nodejs_gapic_library(
src = ":automl_proto_with_info",
gapic_yaml = "automl_gapic.yaml",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
deps = [],
)
@ -337,7 +343,7 @@ ruby_gapic_library(
src = ":automl_proto_with_info",
gapic_yaml = "automl_gapic.yaml",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
deps = [
":automl_ruby_grpc",
":automl_ruby_proto",
@ -381,7 +387,7 @@ csharp_gapic_library(
src = ":automl_proto_with_info",
gapic_yaml = "automl_gapic.yaml",
package = "google.cloud.automl.v1beta1",
service_yaml = "//google/cloud/automl:automl_v1beta1.yaml",
service_yaml = "automl_v1beta1.yaml",
deps = [
":automl_csharp_grpc",
":automl_csharp_proto",

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
@ -27,16 +27,19 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// A definition of an annotation spec.
message AnnotationSpec {
option (google.api.resource) = {
type: "automl.googleapis.com/AnnotationSpec"
pattern: "projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}"
};
// Output only. Resource name of the annotation spec.
// Form:
//
// 'projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationSpecs/{annotation_spec_id}'
string name = 1;
// Required.
// The name of the annotation spec to show in the interface. The name can be
// Required. The name of the annotation spec to show in the interface. The name can be
// up to 32 characters long and must match the regexp `[a-zA-Z0-9_]+`.
// (_), and ASCII digits 0-9.
string display_name = 2;
// Output only. The number of examples in the parent dataset

View File

@ -0,0 +1,133 @@
{
"methodConfig": [
{
"name": [
{
"service": "google.cloud.automl.v1beta1.PredictionService",
"method": "Predict"
},
{
"service": "google.cloud.automl.v1beta1.PredictionService",
"method": "BatchPredict"
}
],
"timeout": "60s"
},
{
"name": [
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "CreateDataset"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "UpdateDataset"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ImportData"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ExportData"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "CreateModel"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "DeployModel"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "UndeployModel"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ExportModel"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ExportEvaluatedExamples"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ListModelEvaluations"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "UpdateTableSpec"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "UpdateColumnSpec"
}
],
"timeout": "5s"
},
{
"name": [
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "GetDataset"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ListDatasets"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "DeleteDataset"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "GetModel"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ListModels"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "DeleteModel"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "GetModelEvaluation"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "GetAnnotationSpec"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "GetTableSpec"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ListTableSpecs"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "GetColumnSpec"
},
{
"service": "google.cloud.automl.v1beta1.AutoMl",
"method": "ListColumnSpecs"
}
],
"timeout": "5s",
"retryPolicy": {
"maxAttempts": 5,
"initialBackoff": "0.100s",
"maxBackoff": "60s",
"backoffMultiplier": 1.3,
"retryableStatusCodes": [
"UNAVAILABLE",
"DEADLINE_EXCEEDED"
]
}
}
]
}

View File

@ -0,0 +1,127 @@
type: google.api.Service
config_version: 3
name: automl.googleapis.com
title: Cloud AutoML API
apis:
- name: google.cloud.automl.v1beta1.AutoMl
- name: google.cloud.automl.v1beta1.PredictionService
types:
- name: google.cloud.automl.v1beta1.BatchPredictResult
- name: google.cloud.automl.v1beta1.OperationMetadata
documentation:
summary: |-
Train high-quality custom machine learning models with minimum effort and
machine learning expertise.
overview: |-
Cloud AutoML is a suite of machine learning products that enables
developers with limited machine learning expertise to train high-quality
models specific to their business needs, by leveraging Google's
state-of-the-art transfer learning, and Neural Architecture Search
technology.
rules:
- selector: google.iam.v1.IAMPolicy.GetIamPolicy
description: |-
Gets the access control policy for a resource. Returns an empty policy
if the resource exists and does not have a policy set.
- selector: google.iam.v1.IAMPolicy.SetIamPolicy
description: |-
Sets the access control policy on the specified resource. Replaces
any existing policy.
Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and
PERMISSION_DENIED
- selector: google.iam.v1.IAMPolicy.TestIamPermissions
description: |-
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
backend:
rules:
- selector: 'google.cloud.automl.v1beta1.AutoMl.*'
deadline: 5.0
- selector: google.cloud.automl.v1beta1.AutoMl.CreateModel
deadline: 20.0
- selector: google.cloud.automl.v1beta1.AutoMl.ImportData
deadline: 20.0
- selector: google.cloud.automl.v1beta1.AutoMl.ListDatasets
deadline: 50.0
- selector: google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations
deadline: 50.0
- selector: google.cloud.automl.v1beta1.AutoMl.ListModels
deadline: 50.0
- selector: google.cloud.automl.v1beta1.PredictionService.BatchPredict
deadline: 20.0
- selector: google.cloud.automl.v1beta1.PredictionService.Predict
deadline: 60.0
- selector: 'google.iam.v1.IAMPolicy.*'
deadline: 5.0
- selector: 'google.longrunning.Operations.*'
deadline: 5.0
- selector: google.longrunning.Operations.ListOperations
deadline: 50.0
- selector: google.longrunning.Operations.WaitOperation
deadline: 300.0
http:
rules:
- selector: google.iam.v1.IAMPolicy.GetIamPolicy
get: '/v1beta1/{resource=projects/*/locations/*}:getIamPolicy'
additional_bindings:
- get: '/v1beta1/{resource=projects/*/locations/*/datasets/*}:getIamPolicy'
- get: '/v1beta1/{resource=projects/*/locations/*/models/*}:getIamPolicy'
- selector: google.iam.v1.IAMPolicy.SetIamPolicy
post: '/v1beta1/{resource=projects/*/locations/*}:setIamPolicy'
body: '*'
additional_bindings:
- post: '/v1beta1/{resource=projects/*/locations/*/datasets/*}:setIamPolicy'
body: '*'
- post: '/v1beta1/{resource=projects/*/locations/*/models/*}:setIamPolicy'
body: '*'
- selector: google.iam.v1.IAMPolicy.TestIamPermissions
post: '/v1beta1/{resource=projects/*/locations/*/**}:testIamPermissions'
body: '*'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1beta1/{name=projects/*/locations/*/operations/*}:cancel'
body: '*'
- selector: google.longrunning.Operations.DeleteOperation
delete: '/v1beta1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.GetOperation
get: '/v1beta1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.ListOperations
get: '/v1beta1/{name=projects/*/locations/*}/operations'
- selector: google.longrunning.Operations.WaitOperation
post: '/v1beta1/{name=projects/*/locations/*/operations/*}:wait'
body: '*'
authentication:
rules:
- selector: 'google.cloud.automl.v1beta1.AutoMl.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.automl.v1beta1.PredictionService.BatchPredict
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.automl.v1beta1.PredictionService.Predict
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.iam.v1.IAMPolicy.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,14 +11,13 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/cloud/automl/v1beta1/temporal.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_outer_classname = "ClassificationProto";
@ -126,10 +125,7 @@ message ClassificationEvaluationMetrics {
// for each example.
float false_positive_rate_at1 = 9;
// Output only. The harmonic mean of
// [recall_at1][google.cloud.automl.v1beta1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry.recall_at1]
// and
// [precision_at1][google.cloud.automl.v1beta1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry.precision_at1].
// Output only. The harmonic mean of [recall_at1][google.cloud.automl.v1beta1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry.recall_at1] and [precision_at1][google.cloud.automl.v1beta1.ClassificationEvaluationMetrics.ConfidenceMetricsEntry.precision_at1].
float f1_score_at1 = 7;
// Output only. The number of model created labels that match a ground truth
@ -156,9 +152,7 @@ message ClassificationEvaluationMetrics {
// Output only. Value of the specific cell in the confusion matrix.
// The number of values each row has (i.e. the length of the row) is equal
// to the length of the `annotation_spec_id` field or, if that one is not
// populated, length of the
// [display_name][google.cloud.automl.v1beta1.ClassificationEvaluationMetrics.ConfusionMatrix.display_name]
// field.
// populated, length of the [display_name][google.cloud.automl.v1beta1.ClassificationEvaluationMetrics.ConfusionMatrix.display_name] field.
repeated int32 example_count = 1;
}

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/data_stats.proto";
import "google/cloud/automl/v1beta1/data_types.proto";
import "google/api/annotations.proto";
@ -32,6 +32,11 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// Used by:
// * Tables
message ColumnSpec {
option (google.api.resource) = {
type: "automl.googleapis.com/ColumnSpec"
pattern: "projects/{project}/locations/{location}/datasets/{dataset}/tableSpecs/{table_spec}/columnSpecs/{column_spec}"
};
// Identifies the table's column, and its correlation with the column this
// ColumnSpec describes.
message CorrelatedColumn {

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,19 +11,19 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/cloud/automl/v1beta1/geometry.proto";
import "google/cloud/automl/v1beta1/io.proto";
import "google/cloud/automl/v1beta1/temporal.proto";
import "google/cloud/automl/v1beta1/text_segment.proto";
import "google/protobuf/any.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/struct.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
@ -35,11 +35,9 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// Only images up to 30MB in size are supported.
message Image {
// Input only. The data representing the image.
// For Predict calls
// [image_bytes][google.cloud.automl.v1beta1.Image.image_bytes] must be set,
// as other options are not currently supported by prediction API. You can
// read the contents of an uploaded image by using the
// [content_uri][google.cloud.automl.v1beta1.Image.content_uri] field.
// For Predict calls [image_bytes][google.cloud.automl.v1beta1.Image.image_bytes] must be set, as other options are not
// currently supported by prediction API. You can read the contents of an
// uploaded image by using the [content_uri][google.cloud.automl.v1beta1.Image.content_uri] field.
oneof data {
// Image content represented as a stream of bytes.
// Note: As with all `bytes` fields, protobuffers use a pure binary
@ -60,11 +58,9 @@ message TextSnippet {
// characters long.
string content = 1;
// Optional. The format of
// [content][google.cloud.automl.v1beta1.TextSnippet.content]. Currently the
// only two allowed values are "text/html" and "text/plain". If left blank,
// the format is automatically determined from the type of the uploaded
// [content][google.cloud.automl.v1beta1.TextSnippet.content].
// Optional. The format of [content][google.cloud.automl.v1beta1.TextSnippet.content]. Currently the only two allowed
// values are "text/html" and "text/plain". If left blank, the format is
// automatically determined from the type of the uploaded [content][google.cloud.automl.v1beta1.TextSnippet.content].
string mime_type = 2;
// Output only. HTTP URI where you can download the content.
@ -100,9 +96,7 @@ message DocumentDimensions {
// A structured text document e.g. a PDF.
message Document {
// Describes the layout information of a
// [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment] in
// the document.
// Describes the layout information of a [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment] in the document.
message Layout {
// The type of TextSegment in the context of the original document.
enum TextSegmentType {
@ -151,14 +145,12 @@ message Document {
// [document_text][google.cloud.automl.v1beta1.Document.document_text].
TextSegment text_segment = 1;
// Page number of the
// [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment]
// in the original document, starts from 1.
// Page number of the [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment] in the original document, starts
// from 1.
int32 page_number = 2;
// The position of the
// [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment]
// in the page. Contains exactly 4
// The position of the [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment] in the page.
// Contains exactly 4
//
// [normalized_vertices][google.cloud.automl.v1beta1.BoundingPoly.normalized_vertices]
// and they are connected by edges in the order provided, which will
@ -168,9 +160,7 @@ message Document {
// Coordinates are based on top-left as point (0,0).
BoundingPoly bounding_poly = 3;
// The type of the
// [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment]
// in document.
// The type of the [text_segment][google.cloud.automl.v1beta1.Document.Layout.text_segment] in document.
TextSegmentType text_segment_type = 4;
}

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/image.proto";
import "google/cloud/automl/v1beta1/tables.proto";
import "google/cloud/automl/v1beta1/text.proto";
@ -34,6 +34,11 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// A workspace for solving a single, particular machine learning (ML) problem.
// A workspace contains examples that may be annotated.
message Dataset {
option (google.api.resource) = {
type: "automl.googleapis.com/Dataset"
pattern: "projects/{project}/locations/{location}/datasets/{dataset}"
};
// Required.
// The dataset metadata that is specific to the problem type.
oneof dataset_metadata {

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,16 +11,16 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/annotation_spec.proto";
import "google/cloud/automl/v1beta1/classification.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
@ -36,7 +36,9 @@ message ImageClassificationDatasetMetadata {
}
// Dataset metadata specific to image object detection.
message ImageObjectDetectionDatasetMetadata {}
message ImageObjectDetectionDatasetMetadata {
}
// Model metadata for image classification.
message ImageClassificationModelMetadata {
@ -65,38 +67,34 @@ message ImageClassificationModelMetadata {
// This is the default value.
// * `mobile-low-latency-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel])
// and used on a mobile or edge device with TensorFlow
// afterwards. Expected to have low latency, but may have lower
// prediction quality than other models.
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile or edge device
// with TensorFlow afterwards. Expected to have low latency, but
// may have lower prediction quality than other models.
// * `mobile-versatile-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel])
// and used on a mobile or edge device with TensorFlow
// afterwards.
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile or edge device
// with TensorFlow afterwards.
// * `mobile-high-accuracy-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel])
// and used on a mobile or edge device with TensorFlow
// afterwards. Expected to have a higher latency, but should
// also have a higher prediction quality than other models.
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile or edge device
// with TensorFlow afterwards. Expected to have a higher
// latency, but should also have a higher prediction quality
// than other models.
// * `mobile-core-ml-low-latency-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel])
// and used on a mobile device with Core ML afterwards. Expected
// to have low latency, but may have lower prediction quality
// than other models.
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile device with Core
// ML afterwards. Expected to have low latency, but may have
// lower prediction quality than other models.
// * `mobile-core-ml-versatile-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel])
// and used on a mobile device with Core ML afterwards.
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile device with Core
// ML afterwards.
// * `mobile-core-ml-high-accuracy-1` - A model that, in addition to
// providing prediction via AutoML API, can also be exported
// (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel])
// and used on a mobile device with Core ML afterwards. Expected
// to have a higher latency, but should also have a higher
// prediction quality than other models.
// (see [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile device with
// Core ML afterwards. Expected to have a higher latency, but
// should also have a higher prediction quality than other
// models.
string model_type = 7;
// Output only. An approximate number of online prediction QPS that can
@ -119,6 +117,21 @@ message ImageObjectDetectionModelMetadata {
// * `cloud-low-latency-1` - A model to be used via prediction
// calls to AutoML API. Expected to have low latency, but may
// have lower prediction quality than other models.
// * `mobile-low-latency-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile or edge device
// with TensorFlow afterwards. Expected to have low latency, but
// may have lower prediction quality than other models.
// * `mobile-versatile-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile or edge device
// with TensorFlow afterwards.
// * `mobile-high-accuracy-1` - A model that, in addition to providing
// prediction via AutoML API, can also be exported (see
// [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel]) and used on a mobile or edge device
// with TensorFlow afterwards. Expected to have a higher
// latency, but should also have a higher prediction quality
// than other models.
string model_type = 1;
// Output only. The number of nodes this model is deployed on. A node is an

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/image.proto";
import "google/cloud/automl/v1beta1/tables.proto";
import "google/cloud/automl/v1beta1/text.proto";
@ -33,6 +33,11 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// API proto representing a trained machine learning model.
message Model {
option (google.api.resource) = {
type: "automl.googleapis.com/Model"
pattern: "projects/{project}/locations/{location}/models/{model}"
};
// Deployment state of the model.
enum DeploymentState {
// Should not be used, an un-set enum has this value by default.

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/classification.proto";
import "google/cloud/automl/v1beta1/detection.proto";
import "google/cloud/automl/v1beta1/regression.proto";
@ -35,6 +35,11 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// Evaluation results of a model.
message ModelEvaluation {
option (google.api.resource) = {
type: "automl.googleapis.com/ModelEvaluation"
pattern: "projects/{project}/locations/{location}/models/{model}/modelEvaluations/{model_evaluation}"
};
// Output only. Problem type specific evaluation metrics.
oneof metrics {
// Model evaluation metrics for image, text, video and tables

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,16 +11,18 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/cloud/automl/v1beta1/io.proto";
import "google/cloud/automl/v1beta1/model.proto";
import "google/cloud/automl/v1beta1/model_evaluation.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
@ -58,8 +60,7 @@ message OperationMetadata {
ExportModelOperationMetadata export_model_details = 22;
// Details of ExportEvaluatedExamples operation.
ExportEvaluatedExamplesOperationMetadata export_evaluated_examples_details =
26;
ExportEvaluatedExamplesOperationMetadata export_evaluated_examples_details = 26;
}
// Output only. Progress of operation. Range: [0, 100].
@ -80,19 +81,29 @@ message OperationMetadata {
}
// Details of operations that perform deletes of any entities.
message DeleteOperationMetadata {}
message DeleteOperationMetadata {
}
// Details of DeployModel operation.
message DeployModelOperationMetadata {}
message DeployModelOperationMetadata {
}
// Details of UndeployModel operation.
message UndeployModelOperationMetadata {}
message UndeployModelOperationMetadata {
}
// Details of CreateModel operation.
message CreateModelOperationMetadata {}
message CreateModelOperationMetadata {
}
// Details of ImportData operation.
message ImportDataOperationMetadata {}
message ImportDataOperationMetadata {
}
// Details of ExportData operation.
message ExportDataOperationMetadata {

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";
@ -19,6 +18,8 @@ package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/annotation_payload.proto";
import "google/cloud/automl/v1beta1/data_items.proto";
import "google/cloud/automl/v1beta1/io.proto";
@ -38,8 +39,7 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// snake_case or kebab-case, either of those cases is accepted.
service PredictionService {
option (google.api.default_host) = "automl.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
// Perform an online prediction. The prediction result will be directly
// returned in the response.
@ -65,16 +65,15 @@ service PredictionService {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:predict"
body: "*"
};
option (google.api.method_signature) = "name,payload,params";
}
// Perform a batch prediction. Unlike the online
// [Predict][google.cloud.automl.v1beta1.PredictionService.Predict], batch
// Perform a batch prediction. Unlike the online [Predict][google.cloud.automl.v1beta1.PredictionService.Predict], batch
// prediction result won't be immediately available in the response. Instead,
// a long running operation object is returned. User can poll the operation
// result via [GetOperation][google.longrunning.Operations.GetOperation]
// method. Once the operation is done,
// [BatchPredictResult][google.cloud.automl.v1beta1.BatchPredictResult] is
// returned in the [response][google.longrunning.Operation.response] field.
// method. Once the operation is done, [BatchPredictResult][google.cloud.automl.v1beta1.BatchPredictResult] is returned in
// the [response][google.longrunning.Operation.response] field.
// Available for following ML problems:
// * Image Classification
// * Image Object Detection
@ -86,18 +85,27 @@ service PredictionService {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:batchPredict"
body: "*"
};
option (google.api.method_signature) = "name,input_config,output_config,params";
option (google.longrunning.operation_info) = {
response_type: "BatchPredictResult"
metadata_type: "OperationMetadata"
};
}
}
// Request message for
// [PredictionService.Predict][google.cloud.automl.v1beta1.PredictionService.Predict].
// Request message for [PredictionService.Predict][google.cloud.automl.v1beta1.PredictionService.Predict].
message PredictRequest {
// Name of the model requested to serve the prediction.
string name = 1;
// Required. Name of the model requested to serve the prediction.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
// Required. Payload to perform a prediction on. The payload must match the
// problem type that the model was trained to solve.
ExamplePayload payload = 2;
ExamplePayload payload = 2 [(google.api.field_behavior) = REQUIRED];
// Additional domain-specific parameters, any string must be up to 25000
// characters long.
@ -116,18 +124,13 @@ message PredictRequest {
// boxes will be returned in the response. Default is 100, the
// requested value may be limited by server.
// * For Tables:
// `feature_importance` - (boolean) Whether
//
// [feature_importance][[google.cloud.automl.v1beta1.TablesModelColumnInfo.feature_importance]
// should be populated in the returned
//
// [TablesAnnotation(-s)][[google.cloud.automl.v1beta1.TablesAnnotation].
// feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
// should be populated in the returned TablesAnnotation.
// The default is false.
map<string, string> params = 3;
}
// Response message for
// [PredictionService.Predict][google.cloud.automl.v1beta1.PredictionService.Predict].
// Response message for [PredictionService.Predict][google.cloud.automl.v1beta1.PredictionService.Predict].
message PredictResponse {
// Prediction result.
// Translation and Text Sentiment will return precisely one payload.
@ -158,20 +161,24 @@ message PredictResponse {
map<string, string> metadata = 2;
}
// Request message for
// [PredictionService.BatchPredict][google.cloud.automl.v1beta1.PredictionService.BatchPredict].
// Request message for [PredictionService.BatchPredict][google.cloud.automl.v1beta1.PredictionService.BatchPredict].
message BatchPredictRequest {
// Name of the model requested to serve the batch prediction.
string name = 1;
// Required. Name of the model requested to serve the batch prediction.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
// Required. The input configuration for batch prediction.
BatchPredictInputConfig input_config = 3;
BatchPredictInputConfig input_config = 3 [(google.api.field_behavior) = REQUIRED];
// Required. The Configuration specifying where output predictions should
// be written.
BatchPredictOutputConfig output_config = 4;
BatchPredictOutputConfig output_config = 4 [(google.api.field_behavior) = REQUIRED];
// Additional domain-specific parameters for the predictions, any string must
// Required. Additional domain-specific parameters for the predictions, any string must
// be up to 25000 characters long.
//
// * For Text Classification:
@ -196,6 +203,7 @@ message BatchPredictRequest {
// requested value may be limited by server.
//
// * For Video Classification :
//
// `score_threshold` - (float) A value from 0.0 to 1.0. When the model
// makes predictions for a video, it will only produce results that
// have at least this confidence score. The default is 0.5.
@ -223,7 +231,14 @@ message BatchPredictRequest {
// metrics provided to describe that quality. The default is
// "false".
//
// * For Tables:
//
// feature_imp<span>ortan</span>ce - (boolean) Whether feature importance
// should be populated in the returned TablesAnnotations. The
// default is false.
//
// * For Video Object Tracking:
//
// `score_threshold` - (float) When Model detects objects on video frames,
// it will only produce bounding boxes which have at least this
// confidence score. Value in 0 to 1 range, default is 0.5.
@ -233,14 +248,12 @@ message BatchPredictRequest {
// `min_bounding_box_size` - (float) Only bounding boxes with shortest edge
// at least that long as a relative value of video frame size will be
// returned. Value in 0 to 1 range. Default is 0.
//
map<string, string> params = 5;
map<string, string> params = 5 [(google.api.field_behavior) = REQUIRED];
}
// Result of the Batch Predict. This message is returned in
// [response][google.longrunning.Operation.response] of the operation returned
// by the
// [PredictionService.BatchPredict][google.cloud.automl.v1beta1.PredictionService.BatchPredict].
// by the [PredictionService.BatchPredict][google.cloud.automl.v1beta1.PredictionService.BatchPredict].
message BatchPredictResult {
// Additional domain-specific prediction response metadata.
//

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,13 +11,15 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/annotation_payload.proto";
import "google/cloud/automl/v1beta1/annotation_spec.proto";
import "google/cloud/automl/v1beta1/column_spec.proto";
@ -30,7 +32,6 @@ import "google/cloud/automl/v1beta1/operations.proto";
import "google/cloud/automl/v1beta1/table_spec.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
import "google/api/client.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
@ -63,6 +64,7 @@ service AutoMl {
post: "/v1beta1/{parent=projects/*/locations/*}/datasets"
body: "dataset"
};
option (google.api.method_signature) = "parent,dataset";
}
// Gets a dataset.
@ -70,6 +72,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/datasets/*}"
};
option (google.api.method_signature) = "name";
}
// Lists datasets in a project.
@ -77,6 +80,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/datasets"
};
option (google.api.method_signature) = "parent";
}
// Updates a dataset.
@ -85,6 +89,7 @@ service AutoMl {
patch: "/v1beta1/{dataset.name=projects/*/locations/*/datasets/*}"
body: "dataset"
};
option (google.api.method_signature) = "dataset";
}
// Deletes a dataset and all of its contents.
@ -96,6 +101,11 @@ service AutoMl {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/datasets/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Imports data into a dataset.
@ -112,6 +122,11 @@ service AutoMl {
post: "/v1beta1/{name=projects/*/locations/*/datasets/*}:importData"
body: "*"
};
option (google.api.method_signature) = "name,input_config";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Exports dataset's data to the provided output location.
@ -122,6 +137,11 @@ service AutoMl {
post: "/v1beta1/{name=projects/*/locations/*/datasets/*}:exportData"
body: "*"
};
option (google.api.method_signature) = "name,output_config";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Gets an annotation spec.
@ -129,6 +149,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*}"
};
option (google.api.method_signature) = "name";
}
// Gets a table spec.
@ -136,6 +157,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/datasets/*/tableSpecs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists table specs in a dataset.
@ -143,6 +165,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/datasets/*}/tableSpecs"
};
option (google.api.method_signature) = "parent";
}
// Updates a table spec.
@ -151,6 +174,7 @@ service AutoMl {
patch: "/v1beta1/{table_spec.name=projects/*/locations/*/datasets/*/tableSpecs/*}"
body: "table_spec"
};
option (google.api.method_signature) = "table_spec";
}
// Gets a column spec.
@ -158,6 +182,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/datasets/*/tableSpecs/*/columnSpecs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists column specs in a table spec.
@ -165,6 +190,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/datasets/*/tableSpecs/*}/columnSpecs"
};
option (google.api.method_signature) = "parent";
}
// Updates a column spec.
@ -173,6 +199,7 @@ service AutoMl {
patch: "/v1beta1/{column_spec.name=projects/*/locations/*/datasets/*/tableSpecs/*/columnSpecs/*}"
body: "column_spec"
};
option (google.api.method_signature) = "column_spec";
}
// Creates a model.
@ -185,6 +212,11 @@ service AutoMl {
post: "/v1beta1/{parent=projects/*/locations/*}/models"
body: "model"
};
option (google.api.method_signature) = "parent,model";
option (google.longrunning.operation_info) = {
response_type: "Model"
metadata_type: "OperationMetadata"
};
}
// Gets a model.
@ -192,6 +224,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/models/*}"
};
option (google.api.method_signature) = "name";
}
// Lists models.
@ -199,6 +232,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*}/models"
};
option (google.api.method_signature) = "parent";
}
// Deletes a model.
@ -210,6 +244,11 @@ service AutoMl {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/models/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Deploys a model. If a model is already deployed, deploying it with the
@ -219,7 +258,8 @@ service AutoMl {
// [node_number][google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata.node_number])
// will reset the deployment state without pausing the model's availability.
//
// Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically.
// Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage
// deployment automatically.
//
// Returns an empty response in the
// [response][google.longrunning.Operation.response] field when it completes.
@ -228,6 +268,11 @@ service AutoMl {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:deploy"
body: "*"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Undeploys a model. If the model is not deployed this method has no effect.
@ -242,6 +287,11 @@ service AutoMl {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:undeploy"
body: "*"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Exports a trained, "export-able", model to a user specified Google Cloud
@ -257,6 +307,11 @@ service AutoMl {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:export"
body: "*"
};
option (google.api.method_signature) = "name,output_config";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Exports examples on which the model was evaluated (i.e. which were in the
@ -278,6 +333,11 @@ service AutoMl {
post: "/v1beta1/{name=projects/*/locations/*/models/*}:exportEvaluatedExamples"
body: "*"
};
option (google.api.method_signature) = "name,output_config";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Gets a model evaluation.
@ -285,6 +345,7 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{name=projects/*/locations/*/models/*/modelEvaluations/*}"
};
option (google.api.method_signature) = "name";
}
// Lists model evaluations.
@ -292,28 +353,44 @@ service AutoMl {
option (google.api.http) = {
get: "/v1beta1/{parent=projects/*/locations/*/models/*}/modelEvaluations"
};
option (google.api.method_signature) = "parent";
}
}
// Request message for [AutoMl.CreateDataset][google.cloud.automl.v1beta1.AutoMl.CreateDataset].
message CreateDatasetRequest {
// The resource name of the project to create the dataset for.
string parent = 1;
// Required. The resource name of the project to create the dataset for.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The dataset to create.
Dataset dataset = 2;
// Required. The dataset to create.
Dataset dataset = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [AutoMl.GetDataset][google.cloud.automl.v1beta1.AutoMl.GetDataset].
message GetDatasetRequest {
// The resource name of the dataset to retrieve.
string name = 1;
// Required. The resource name of the dataset to retrieve.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Dataset"
}
];
}
// Request message for [AutoMl.ListDatasets][google.cloud.automl.v1beta1.AutoMl.ListDatasets].
message ListDatasetsRequest {
// The resource name of the project from which to list datasets.
string parent = 1;
// Required. The resource name of the project from which to list datasets.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// An expression for filtering the results of the request.
//
@ -347,8 +424,8 @@ message ListDatasetsResponse {
// Request message for [AutoMl.UpdateDataset][google.cloud.automl.v1beta1.AutoMl.UpdateDataset]
message UpdateDatasetRequest {
// The dataset which replaces the resource on the server.
Dataset dataset = 1;
// Required. The dataset which replaces the resource on the server.
Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED];
// The update mask applies to the resource.
google.protobuf.FieldMask update_mask = 2;
@ -356,40 +433,65 @@ message UpdateDatasetRequest {
// Request message for [AutoMl.DeleteDataset][google.cloud.automl.v1beta1.AutoMl.DeleteDataset].
message DeleteDatasetRequest {
// The resource name of the dataset to delete.
string name = 1;
// Required. The resource name of the dataset to delete.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Dataset"
}
];
}
// Request message for [AutoMl.ImportData][google.cloud.automl.v1beta1.AutoMl.ImportData].
message ImportDataRequest {
// Required. Dataset name. Dataset must already exist. All imported
// annotations and examples will be added.
string name = 1;
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Dataset"
}
];
// Required. The desired input location and its domain specific semantics,
// if any.
InputConfig input_config = 3;
InputConfig input_config = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [AutoMl.ExportData][google.cloud.automl.v1beta1.AutoMl.ExportData].
message ExportDataRequest {
// Required. The resource name of the dataset.
string name = 1;
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Dataset"
}
];
// Required. The desired output location.
OutputConfig output_config = 3;
OutputConfig output_config = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [AutoMl.GetAnnotationSpec][google.cloud.automl.v1beta1.AutoMl.GetAnnotationSpec].
message GetAnnotationSpecRequest {
// The resource name of the annotation spec to retrieve.
string name = 1;
// Required. The resource name of the annotation spec to retrieve.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/AnnotationSpec"
}
];
}
// Request message for [AutoMl.GetTableSpec][google.cloud.automl.v1beta1.AutoMl.GetTableSpec].
message GetTableSpecRequest {
// The resource name of the table spec to retrieve.
string name = 1;
// Required. The resource name of the table spec to retrieve.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/TableSpec"
}
];
// Mask specifying which fields to read.
google.protobuf.FieldMask field_mask = 2;
@ -397,8 +499,13 @@ message GetTableSpecRequest {
// Request message for [AutoMl.ListTableSpecs][google.cloud.automl.v1beta1.AutoMl.ListTableSpecs].
message ListTableSpecsRequest {
// The resource name of the dataset to list table specs from.
string parent = 1;
// Required. The resource name of the dataset to list table specs from.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Dataset"
}
];
// Mask specifying which fields to read.
google.protobuf.FieldMask field_mask = 2;
@ -429,8 +536,8 @@ message ListTableSpecsResponse {
// Request message for [AutoMl.UpdateTableSpec][google.cloud.automl.v1beta1.AutoMl.UpdateTableSpec]
message UpdateTableSpecRequest {
// The table spec which replaces the resource on the server.
TableSpec table_spec = 1;
// Required. The table spec which replaces the resource on the server.
TableSpec table_spec = 1 [(google.api.field_behavior) = REQUIRED];
// The update mask applies to the resource.
google.protobuf.FieldMask update_mask = 2;
@ -438,8 +545,13 @@ message UpdateTableSpecRequest {
// Request message for [AutoMl.GetColumnSpec][google.cloud.automl.v1beta1.AutoMl.GetColumnSpec].
message GetColumnSpecRequest {
// The resource name of the column spec to retrieve.
string name = 1;
// Required. The resource name of the column spec to retrieve.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/ColumnSpec"
}
];
// Mask specifying which fields to read.
google.protobuf.FieldMask field_mask = 2;
@ -447,8 +559,13 @@ message GetColumnSpecRequest {
// Request message for [AutoMl.ListColumnSpecs][google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs].
message ListColumnSpecsRequest {
// The resource name of the table spec to list column specs from.
string parent = 1;
// Required. The resource name of the table spec to list column specs from.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/TableSpec"
}
];
// Mask specifying which fields to read.
google.protobuf.FieldMask field_mask = 2;
@ -479,8 +596,8 @@ message ListColumnSpecsResponse {
// Request message for [AutoMl.UpdateColumnSpec][google.cloud.automl.v1beta1.AutoMl.UpdateColumnSpec]
message UpdateColumnSpecRequest {
// The column spec which replaces the resource on the server.
ColumnSpec column_spec = 1;
// Required. The column spec which replaces the resource on the server.
ColumnSpec column_spec = 1 [(google.api.field_behavior) = REQUIRED];
// The update mask applies to the resource.
google.protobuf.FieldMask update_mask = 2;
@ -488,23 +605,38 @@ message UpdateColumnSpecRequest {
// Request message for [AutoMl.CreateModel][google.cloud.automl.v1beta1.AutoMl.CreateModel].
message CreateModelRequest {
// Resource name of the parent project where the model is being created.
string parent = 1;
// Required. Resource name of the parent project where the model is being created.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// The model to create.
Model model = 4;
// Required. The model to create.
Model model = 4 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [AutoMl.GetModel][google.cloud.automl.v1beta1.AutoMl.GetModel].
message GetModelRequest {
// Resource name of the model.
string name = 1;
// Required. Resource name of the model.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
}
// Request message for [AutoMl.ListModels][google.cloud.automl.v1beta1.AutoMl.ListModels].
message ListModelsRequest {
// Resource name of the project, from which to list the models.
string parent = 1;
// Required. Resource name of the project, from which to list the models.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];
// An expression for filtering the results of the request.
//
@ -539,8 +671,13 @@ message ListModelsResponse {
// Request message for [AutoMl.DeleteModel][google.cloud.automl.v1beta1.AutoMl.DeleteModel].
message DeleteModelRequest {
// Resource name of the model being deleted.
string name = 1;
// Required. Resource name of the model being deleted.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
}
// Request message for [AutoMl.DeployModel][google.cloud.automl.v1beta1.AutoMl.DeployModel].
@ -549,18 +686,29 @@ message DeployModelRequest {
oneof model_deployment_metadata {
// Model deployment metadata specific to Image Object Detection.
ImageObjectDetectionModelDeploymentMetadata image_object_detection_model_deployment_metadata = 2;
// Model deployment metadata specific to Image Classification.
ImageClassificationModelDeploymentMetadata image_classification_model_deployment_metadata = 4;
}
// Resource name of the model to deploy.
string name = 1;
// Required. Resource name of the model to deploy.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
}
// Request message for [AutoMl.UndeployModel][google.cloud.automl.v1beta1.AutoMl.UndeployModel].
message UndeployModelRequest {
// Resource name of the model to undeploy.
string name = 1;
// Required. Resource name of the model to undeploy.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
}
// Request message for [AutoMl.ExportModel][google.cloud.automl.v1beta1.AutoMl.ExportModel].
@ -568,34 +716,54 @@ message UndeployModelRequest {
// returned.
message ExportModelRequest {
// Required. The resource name of the model to export.
string name = 1;
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
// Required. The desired output location and configuration.
ModelExportOutputConfig output_config = 3;
ModelExportOutputConfig output_config = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [AutoMl.ExportEvaluatedExamples][google.cloud.automl.v1beta1.AutoMl.ExportEvaluatedExamples].
message ExportEvaluatedExamplesRequest {
// Required. The resource name of the model whose evaluated examples are to
// be exported.
string name = 1;
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
// Required. The desired output location and configuration.
ExportEvaluatedExamplesOutputConfig output_config = 3;
ExportEvaluatedExamplesOutputConfig output_config = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for [AutoMl.GetModelEvaluation][google.cloud.automl.v1beta1.AutoMl.GetModelEvaluation].
message GetModelEvaluationRequest {
// Resource name for the model evaluation.
string name = 1;
// Required. Resource name for the model evaluation.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/ModelEvaluation"
}
];
}
// Request message for [AutoMl.ListModelEvaluations][google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations].
message ListModelEvaluationsRequest {
// Resource name of the model to list the model evaluations for.
// Required. Resource name of the model to list the model evaluations for.
// If modelId is set as "-", this will list model evaluations from across all
// models of the parent location.
string parent = 1;
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "automl.googleapis.com/Model"
}
];
// An expression for filtering the results of the request.
//

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/resource.proto";
import "google/cloud/automl/v1beta1/io.proto";
import "google/api/annotations.proto";
@ -36,6 +36,11 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// Used by:
// * Tables
message TableSpec {
option (google.api.resource) = {
type: "automl.googleapis.com/TableSpec"
pattern: "projects/{project}/locations/{location}/datasets/{dataset}/tableSpecs/{table_spec}"
};
// Output only. The resource name of the table spec.
// Form:
//

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,21 +11,21 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/cloud/automl/v1beta1/classification.proto";
import "google/cloud/automl/v1beta1/column_spec.proto";
import "google/cloud/automl/v1beta1/data_items.proto";
import "google/cloud/automl/v1beta1/data_stats.proto";
import "google/cloud/automl/v1beta1/ranges.proto";
import "google/cloud/automl/v1beta1/regression.proto";
import "google/cloud/automl/v1beta1/temporal.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
@ -249,6 +249,15 @@ message TablesAnnotation {
// [column_display_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_display_name]
// would be populated, then this whole field is not.
repeated TablesModelColumnInfo tables_model_column_info = 3;
// Output only. Stores the prediction score for the baseline example, which
// is defined as the example with all values set to their baseline values.
// This is used as part of the Sampled Shapley explanation of the model's
// prediction. This field is populated only when feature importance is
// requested. For regression models, this holds the baseline prediction for
// the baseline example. For classification models, this holds the baseline
// prediction for the baseline example for the argmax class.
float baseline_score = 5;
}
// An information specific to given column and Tables Model, in context

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,14 +11,13 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/annotations.proto";
import "google/cloud/automl/v1beta1/classification.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/automl/v1beta1;automl";
option java_multiple_files = true;
@ -40,20 +39,27 @@ message TextClassificationModelMetadata {
}
// Dataset metadata that is specific to text extraction
message TextExtractionDatasetMetadata {}
message TextExtractionDatasetMetadata {
}
// Model metadata that is specific to text extraction.
message TextExtractionModelMetadata {}
message TextExtractionModelMetadata {
}
// Dataset metadata for text sentiment.
message TextSentimentDatasetMetadata {
// Required. A sentiment is expressed as an integer ordinal, where higher
// value means a more positive sentiment. The range of sentiments that will be
// used is between 0 and sentiment_max (inclusive on both ends), and all the
// values in the range must be represented in the dataset before a model can
// be created. sentiment_max value must be between 1 and 10 (inclusive).
// Required. A sentiment is expressed as an integer ordinal, where higher value
// means a more positive sentiment. The range of sentiments that will be used
// is between 0 and sentiment_max (inclusive on both ends), and all the values
// in the range must be represented in the dataset before a model can be
// created.
// sentiment_max value must be between 1 and 10 (inclusive).
int32 sentiment_max = 1;
}
// Model metadata that is specific to text sentiment.
message TextSentimentModelMetadata {}
message TextSentimentModelMetadata {
}

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,12 +11,12 @@
// 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.
//
syntax = "proto3";
package google.cloud.automl.v1beta1;
import "google/api/field_behavior.proto";
import "google/cloud/automl/v1beta1/data_items.proto";
import "google/api/annotations.proto";
@ -30,10 +30,10 @@ option ruby_package = "Google::Cloud::AutoML::V1beta1";
// Dataset metadata that is specific to translation.
message TranslationDatasetMetadata {
// Required. The BCP-47 language code of the source language.
string source_language_code = 1;
string source_language_code = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The BCP-47 language code of the target language.
string target_language_code = 2;
string target_language_code = 2 [(google.api.field_behavior) = REQUIRED];
}
// Evaluation metrics for the dataset.

View File

@ -1,4 +1,4 @@
// Copyright 2019 Google LLC.
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@ -11,7 +11,6 @@
// 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.
//
syntax = "proto3";