From 62687be2a5a452caafb12ee69f297c2af7655133 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 9 Dec 2024 14:19:49 -0800 Subject: [PATCH] docs: Update io.proto to use markdown headings instead of HTML, remove some unused HTML from markdown (#5866) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Update io.proto to use markdown headings instead of HTML, remove some unused HTML from markdown PiperOrigin-RevId: 703192272 Source-Link: https://github.com/googleapis/googleapis/commit/05347e0a68ac16ec35146249d598fcdc6dd8c0c5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/71b95495d6fb29d970ead6a17752d58d1efc8ffb Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWF1dG9tbC8uT3dsQm90LnlhbWwiLCJoIjoiNzFiOTU0OTVkNmZiMjlkOTcwZWFkNmExNzc1MmQ1OGQxZWZjOGZmYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- packages/google-cloud-automl/README.md | 4 +- .../protos/google/cloud/automl/v1/io.proto | 86 ++++++++----------- .../google-cloud-automl/protos/protos.json | 3 + 3 files changed, 42 insertions(+), 51 deletions(-) diff --git a/packages/google-cloud-automl/README.md b/packages/google-cloud-automl/README.md index 37022ee4dd8..1473a0572a5 100644 --- a/packages/google-cloud-automl/README.md +++ b/packages/google-cloud-automl/README.md @@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained]. 1. [Select or create a Cloud Platform project][projects]. 1. [Enable billing for your project][billing]. 1. [Enable the Cloud AutoML API][enable_api]. -1. [Set up authentication with a service account][auth] so you can access the +1. [Set up authentication][auth] so you can access the API from your local workstation. ### Installing the client library @@ -250,4 +250,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE) [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=automl.googleapis.com -[auth]: https://cloud.google.com/docs/authentication/getting-started +[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local diff --git a/packages/google-cloud-automl/protos/google/cloud/automl/v1/io.proto b/packages/google-cloud-automl/protos/google/cloud/automl/v1/io.proto index 8018851f9c5..77d5d36922a 100644 --- a/packages/google-cloud-automl/protos/google/cloud/automl/v1/io.proto +++ b/packages/google-cloud-automl/protos/google/cloud/automl/v1/io.proto @@ -25,7 +25,8 @@ option java_package = "com.google.cloud.automl.v1"; option php_namespace = "Google\\Cloud\\AutoMl\\V1"; option ruby_package = "Google::Cloud::AutoML::V1"; -// Input configuration for [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData] action. +// Input configuration for +// [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData] action. // // The format of input depends on dataset_metadata the Dataset into which // the import is happening has. As input source the @@ -41,10 +42,10 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // The formats are represented in EBNF with commas being literal and with // non-terminal symbols defined near the end of this comment. The formats are: // -//

AutoML Vision

+// #### AutoML Vision // // -//
Classification
+// ##### Classification // // See [Preparing your training // data](https://cloud.google.com/vision/automl/docs/prepare) for more @@ -81,7 +82,7 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // UNASSIGNED,gs://folder/image4.jpg // // -//
Object Detection
+// ##### Object Detection // See [Preparing your training // data](https://cloud.google.com/vision/automl/object-detection/docs/prepare) // for more information. @@ -123,10 +124,10 @@ option ruby_package = "Google::Cloud::AutoML::V1"; //
// // -//

AutoML Video Intelligence

+// #### AutoML Video Intelligence // // -//
Classification
+// ##### Classification // // See [Preparing your training // data](https://cloud.google.com/video-intelligence/automl/docs/prepare) for @@ -169,7 +170,7 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // // // -//
Object Tracking
+// ##### Object Tracking // // See [Preparing your training // data](/video-intelligence/automl/object-tracking/docs/prepare) for more @@ -220,14 +221,12 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // gs://folder/video1.avi,bike,,12.50,.45,.45,,,.55,.55,, // gs://folder/video2.avi,car,1,0,.1,.9,,,.9,.1,, // gs://folder/video2.avi,,,,,,,,,,, -//
-//
// // -//

AutoML Natural Language

+// #### AutoML Natural Language // // -//
Entity Extraction
+// ##### Entity Extraction // // See [Preparing your training // data](/natural-language/automl/entity-analysis/docs/prepare) for more @@ -410,7 +409,7 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // // // -//
Classification
+// ##### Classification // // See [Preparing your training // data](https://cloud.google.com/natural-language/automl/docs/prepare) for more @@ -457,7 +456,7 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // // // -//
Sentiment Analysis
+// ##### Sentiment Analysis // // See [Preparing your training // data](https://cloud.google.com/natural-language/automl/docs/prepare) for more @@ -514,13 +513,10 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // gs://folder/content.txt,3 // TEST,gs://folder/document.pdf // VALIDATE,gs://folder/text_files.zip,2 -//
-//
// // // -//

AutoML Tables

+// #### AutoML Tables // // See [Preparing your training // data](https://cloud.google.com/automl-tables/docs/prepare) for more @@ -559,8 +555,6 @@ option ruby_package = "Google::Cloud::AutoML::V1"; // and between 1000 and 100,000,000 rows, inclusive. There are at most 5 // import data running in parallel. // -//
-//
// // // **Input field definitions:** @@ -641,8 +635,9 @@ message InputConfig { // The source of the input. oneof source { // The Google Cloud Storage location for the input content. - // For [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData], `gcs_source` points to a CSV file with - // a structure described in [InputConfig][google.cloud.automl.v1.InputConfig]. + // For [AutoMl.ImportData][google.cloud.automl.v1.AutoMl.ImportData], + // `gcs_source` points to a CSV file with a structure described in + // [InputConfig][google.cloud.automl.v1.InputConfig]. GcsSource gcs_source = 1; } @@ -650,7 +645,7 @@ message InputConfig { // imported data, any string must be up to 25000 // characters long. // - //

AutoML Tables

+ // #### AutoML Tables // // `schema_inference_version` // : (integer) This value must be supplied. @@ -671,8 +666,8 @@ message InputConfig { // non-terminal symbols defined near the end of this comment. The formats // are: // -//

AutoML Vision

-//
Classification
+// #### AutoML Vision +// ##### Classification // // One or more CSV files where each line is a single column: // @@ -688,7 +683,7 @@ message InputConfig { // gs://folder/image2.gif // gs://folder/image3.png // -//
Object Detection
+// ##### Object Detection // // One or more CSV files where each line is a single column: // @@ -703,11 +698,9 @@ message InputConfig { // gs://folder/image1.jpeg // gs://folder/image2.gif // gs://folder/image3.png -//
-//
// -//

AutoML Video Intelligence

-//
Classification
+// #### AutoML Video Intelligence +// ##### Classification // // One or more CSV files where each line is a single column: // @@ -726,7 +719,7 @@ message InputConfig { // gs://folder/video1.mp4,20,60 // gs://folder/vid2.mov,0,inf // -//
Object Tracking
+// ##### Object Tracking // // One or more CSV files where each line is a single column: // @@ -744,11 +737,9 @@ message InputConfig { // gs://folder/video1.mp4,10,40 // gs://folder/video1.mp4,20,60 // gs://folder/vid2.mov,0,inf -//
-//
// -//

AutoML Natural Language

-//
Classification
+// #### AutoML Natural Language +// ##### Classification // // One or more CSV files where each line is a single column: // @@ -765,7 +756,7 @@ message InputConfig { // gs://folder/text2.pdf // gs://folder/text3.tif // -//
Sentiment Analysis
+// ##### Sentiment Analysis // One or more CSV files where each line is a single column: // // GCS_FILE_PATH @@ -781,7 +772,7 @@ message InputConfig { // gs://folder/text2.pdf // gs://folder/text3.tif // -//
Entity Extraction
+// ##### Entity Extraction // // One or more JSONL (JSON Lines) files that either provide inline text or // documents. You can only use one format, either inline text or documents, @@ -851,11 +842,8 @@ message InputConfig { // } // } // } -//
-//
// -//

AutoML Tables

+// #### AutoML Tables // // See [Preparing your training // data](https://cloud.google.com/automl-tables/docs/predict-batch) for more @@ -901,8 +889,6 @@ message InputConfig { // input feature column specs must contain values compatible with the // column spec's data types. Prediction on all the rows of the table // will be attempted. -//
-//
// // **Input field definitions:** // @@ -984,9 +970,10 @@ message DocumentInputConfig { message OutputConfig { // The destination of the output. oneof destination { - // Required. The Google Cloud Storage location where the output is to be written to. - // For Image Object Detection, Text Extraction, Video Classification and - // Tables, in the given directory a new directory will be created with name: + // Required. The Google Cloud Storage location where the output is to be + // written to. For Image Object Detection, Text Extraction, Video + // Classification and Tables, in the given directory a new directory will be + // created with name: // export_data-- where // timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export // output will be written into that directory. @@ -1246,8 +1233,8 @@ message OutputConfig { message BatchPredictOutputConfig { // The destination of the output. oneof destination { - // Required. The Google Cloud Storage location of the directory where the output is to - // be written to. + // Required. The Google Cloud Storage location of the directory where the + // output is to be written to. GcsDestination gcs_destination = 1 [(google.api.field_behavior) = REQUIRED]; } } @@ -1256,8 +1243,9 @@ message BatchPredictOutputConfig { message ModelExportOutputConfig { // The destination of the output. oneof destination { - // Required. The Google Cloud Storage location where the model is to be written to. - // This location may only be set for the following model formats: + // Required. The Google Cloud Storage location where the model is to be + // written to. This location may only be set for the following model + // formats: // "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml". // // Under the directory given as the destination a new one with name diff --git a/packages/google-cloud-automl/protos/protos.json b/packages/google-cloud-automl/protos/protos.json index 34de0fd8065..50cae48e4f8 100644 --- a/packages/google-cloud-automl/protos/protos.json +++ b/packages/google-cloud-automl/protos/protos.json @@ -1,4 +1,7 @@ { + "options": { + "syntax": "proto3" + }, "nested": { "google": { "nested": {