diff --git a/packages/google-cloud-automl/samples/generated/v1/prediction_service.batch_predict.js b/packages/google-cloud-automl/samples/generated/v1/prediction_service.batch_predict.js index ba45baf6d1a..b6b23e81cb0 100644 --- a/packages/google-cloud-automl/samples/generated/v1/prediction_service.batch_predict.js +++ b/packages/google-cloud-automl/samples/generated/v1/prediction_service.batch_predict.js @@ -108,7 +108,7 @@ function main(name, inputConfig, outputConfig) { * at least that long as a relative value of video frame size are * returned. Value in 0 to 1 range. Default is 0. */ - // const params = 1234 + // const params = [1,2,3,4] // Imports the Automl library const {PredictionServiceClient} = require('@google-cloud/automl').v1; diff --git a/packages/google-cloud-automl/samples/generated/v1/prediction_service.predict.js b/packages/google-cloud-automl/samples/generated/v1/prediction_service.predict.js index 5ca6747f72b..1f5918695cb 100644 --- a/packages/google-cloud-automl/samples/generated/v1/prediction_service.predict.js +++ b/packages/google-cloud-automl/samples/generated/v1/prediction_service.predict.js @@ -62,7 +62,7 @@ function main(name, payload) { * TablesAnnotation google.cloud.automl.v1.TablesAnnotation * objects. The default is false. */ - // const params = 1234 + // const params = [1,2,3,4] // Imports the Automl library const {PredictionServiceClient} = require('@google-cloud/automl').v1; diff --git a/packages/google-cloud-automl/samples/generated/v1/snippet_metadata_google.cloud.automl.v1.json b/packages/google-cloud-automl/samples/generated/v1/snippet_metadata_google.cloud.automl.v1.json new file mode 100644 index 00000000000..f9ada8483d5 --- /dev/null +++ b/packages/google-cloud-automl/samples/generated/v1/snippet_metadata_google.cloud.automl.v1.json @@ -0,0 +1,907 @@ +{ + "clientLibrary": { + "name": "nodejs-automl", + "version": "4.0.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.automl.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "automl_v1_generated_AutoMl_CreateDataset_async", + "title": "automl createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates a dataset.", + "canonical": true, + "file": "auto_ml.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.automl.v1.AutoMl.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.automl.v1.Dataset" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.automl.v1.AutoMl.CreateDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_GetDataset_async", + "title": "automl getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets a dataset.", + "canonical": true, + "file": "auto_ml.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.automl.v1.AutoMl.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.Dataset", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.automl.v1.AutoMl.GetDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_ListDatasets_async", + "title": "automl listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists datasets in a project.", + "canonical": true, + "file": "auto_ml.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.automl.v1.AutoMl.ListDatasets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.ListDatasetsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.automl.v1.AutoMl.ListDatasets", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_UpdateDataset_async", + "title": "automl updateDataset Sample", + "origin": "API_DEFINITION", + "description": " Updates a dataset.", + "canonical": true, + "file": "auto_ml.update_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.automl.v1.AutoMl.UpdateDataset", + "async": true, + "parameters": [ + { + "name": "dataset", + "type": ".google.cloud.automl.v1.Dataset" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1.Dataset", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.automl.v1.AutoMl.UpdateDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_DeleteDataset_async", + "title": "automl deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.", + "canonical": true, + "file": "auto_ml.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.automl.v1.AutoMl.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.automl.v1.AutoMl.DeleteDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_ImportData_async", + "title": "automl importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into a dataset. For Tables this method can only be called on an empty Dataset. For Tables: * A [schema_inference_version][google.cloud.automl.v1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.automl.v1.AutoMl.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "input_config", + "type": ".google.cloud.automl.v1.InputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.automl.v1.AutoMl.ImportData", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_ExportData_async", + "title": "automl exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.automl.v1.AutoMl.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1.OutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.automl.v1.AutoMl.ExportData", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_GetAnnotationSpec_async", + "title": "automl getAnnotationSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets an annotation spec.", + "canonical": true, + "file": "auto_ml.get_annotation_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.automl.v1.AutoMl.GetAnnotationSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.AnnotationSpec", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.automl.v1.AutoMl.GetAnnotationSpec", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_CreateModel_async", + "title": "automl createModel Sample", + "origin": "API_DEFINITION", + "description": " Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.", + "canonical": true, + "file": "auto_ml.create_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateModel", + "fullName": "google.cloud.automl.v1.AutoMl.CreateModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.automl.v1.Model" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "CreateModel", + "fullName": "google.cloud.automl.v1.AutoMl.CreateModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_GetModel_async", + "title": "automl getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a model.", + "canonical": true, + "file": "auto_ml.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.cloud.automl.v1.AutoMl.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.Model", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.cloud.automl.v1.AutoMl.GetModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_ListModels_async", + "title": "automl listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists models.", + "canonical": true, + "file": "auto_ml.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.cloud.automl.v1.AutoMl.ListModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.ListModelsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.cloud.automl.v1.AutoMl.ListModels", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_DeleteModel_async", + "title": "automl deleteModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes a model. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.", + "canonical": true, + "file": "auto_ml.delete_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModel", + "fullName": "google.cloud.automl.v1.AutoMl.DeleteModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "DeleteModel", + "fullName": "google.cloud.automl.v1.AutoMl.DeleteModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_UpdateModel_async", + "title": "automl updateModel Sample", + "origin": "API_DEFINITION", + "description": " Updates a model.", + "canonical": true, + "file": "auto_ml.update_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateModel", + "fullName": "google.cloud.automl.v1.AutoMl.UpdateModel", + "async": true, + "parameters": [ + { + "name": "model", + "type": ".google.cloud.automl.v1.Model" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1.Model", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "UpdateModel", + "fullName": "google.cloud.automl.v1.AutoMl.UpdateModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_DeployModel_async", + "title": "automl deployModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [node_number][google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number]) will reset the deployment state without pausing the model's availability. 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.", + "canonical": true, + "file": "auto_ml.deploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployModel", + "fullName": "google.cloud.automl.v1.AutoMl.DeployModel", + "async": true, + "parameters": [ + { + "name": "image_object_detection_model_deployment_metadata", + "type": ".google.cloud.automl.v1.ImageObjectDetectionModelDeploymentMetadata" + }, + { + "name": "image_classification_model_deployment_metadata", + "type": ".google.cloud.automl.v1.ImageClassificationModelDeploymentMetadata" + }, + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "DeployModel", + "fullName": "google.cloud.automl.v1.AutoMl.DeployModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_UndeployModel_async", + "title": "automl undeployModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys a model. If the model is not deployed this method has no effect. Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.undeploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployModel", + "fullName": "google.cloud.automl.v1.AutoMl.UndeployModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "UndeployModel", + "fullName": "google.cloud.automl.v1.AutoMl.UndeployModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_ExportModel_async", + "title": "automl exportModel Sample", + "origin": "API_DEFINITION", + "description": " Exports a trained, \"export-able\", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig]. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.export_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportModel", + "fullName": "google.cloud.automl.v1.AutoMl.ExportModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1.ModelExportOutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "ExportModel", + "fullName": "google.cloud.automl.v1.AutoMl.ExportModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_GetModelEvaluation_async", + "title": "automl getModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets a model evaluation.", + "canonical": true, + "file": "auto_ml.get_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.automl.v1.AutoMl.GetModelEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.ModelEvaluation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.automl.v1.AutoMl.GetModelEvaluation", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_AutoMl_ListModelEvaluations_async", + "title": "automl listModelEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Lists model evaluations.", + "canonical": true, + "file": "auto_ml.list_model_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.automl.v1.AutoMl.ListModelEvaluations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1.ListModelEvaluationsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1.AutoMlClient" + }, + "method": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.automl.v1.AutoMl.ListModelEvaluations", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1_generated_PredictionService_Predict_async", + "title": "automl predict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction. The prediction result is directly returned in the response. Available for following ML scenarios, and their expected request payloads: AutoML Vision Classification * An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. AutoML Vision Object Detection * An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. AutoML Natural Language Classification * A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB. AutoML Natural Language Entity Extraction * A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document in .PDF, .TIF or .TIFF format with size upto 20MB. AutoML Natural Language Sentiment Analysis * A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in .PDF, .TIF or .TIFF format with size upto 2MB. AutoML Translation * A TextSnippet up to 25,000 characters, UTF-8 encoded. AutoML Tables * A row with column values matching the columns of the model, up to 5MB. Not available for FORECASTING `prediction_type`.", + "canonical": true, + "file": "prediction_service.predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Predict", + "fullName": "google.cloud.automl.v1.PredictionService.Predict", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "payload", + "type": ".google.cloud.automl.v1.ExamplePayload" + }, + { + "name": "params", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.automl.v1.PredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.automl.v1.PredictionServiceClient" + }, + "method": { + "shortName": "Predict", + "fullName": "google.cloud.automl.v1.PredictionService.Predict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.automl.v1.PredictionService" + } + } + } + }, + { + "regionTag": "automl_v1_generated_PredictionService_BatchPredict_async", + "title": "automl batchPredict Sample", + "origin": "API_DEFINITION", + "description": " Perform a batch prediction. Unlike the online [Predict][google.cloud.automl.v1.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.v1.BatchPredictResult] is returned in the [response][google.longrunning.Operation.response] field. Available for following ML scenarios: * AutoML Vision Classification * AutoML Vision Object Detection * AutoML Video Intelligence Classification * AutoML Video Intelligence Object Tracking * AutoML Natural Language Classification * AutoML Natural Language Entity Extraction * AutoML Natural Language Sentiment Analysis * AutoML Tables", + "canonical": true, + "file": "prediction_service.batch_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 133, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchPredict", + "fullName": "google.cloud.automl.v1.PredictionService.BatchPredict", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "input_config", + "type": ".google.cloud.automl.v1.BatchPredictInputConfig" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1.BatchPredictOutputConfig" + }, + { + "name": "params", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.automl.v1.PredictionServiceClient" + }, + "method": { + "shortName": "BatchPredict", + "fullName": "google.cloud.automl.v1.PredictionService.BatchPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.automl.v1.PredictionService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.batch_predict.js b/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.batch_predict.js index 04e308626e2..57e2b419a52 100644 --- a/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.batch_predict.js +++ b/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.batch_predict.js @@ -101,7 +101,7 @@ function main(name, inputConfig, outputConfig, params) { * at least that long as a relative value of video frame size will be * returned. Value in 0 to 1 range. Default is 0. */ - // const params = 1234 + // const params = [1,2,3,4] // Imports the Automl library const {PredictionServiceClient} = require('@google-cloud/automl').v1beta1; diff --git a/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.predict.js b/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.predict.js index 3e4ddfa95cc..1ae50901843 100644 --- a/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.predict.js +++ b/packages/google-cloud-automl/samples/generated/v1beta1/prediction_service.predict.js @@ -56,7 +56,7 @@ function main(name, payload) { * should be populated in the returned TablesAnnotation. * The default is false. */ - // const params = 1234 + // const params = [1,2,3,4] // Imports the Automl library const {PredictionServiceClient} = require('@google-cloud/automl').v1beta1; diff --git a/packages/google-cloud-automl/samples/generated/v1beta1/snippet_metadata_google.cloud.automl.v1beta1.json b/packages/google-cloud-automl/samples/generated/v1beta1/snippet_metadata_google.cloud.automl.v1beta1.json new file mode 100644 index 00000000000..e0dc5502de5 --- /dev/null +++ b/packages/google-cloud-automl/samples/generated/v1beta1/snippet_metadata_google.cloud.automl.v1beta1.json @@ -0,0 +1,1195 @@ +{ + "clientLibrary": { + "name": "nodejs-automl", + "version": "4.0.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.automl.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "automl_v1beta1_generated_AutoMl_CreateDataset_async", + "title": "automl createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates a dataset.", + "canonical": true, + "file": "auto_ml.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.automl.v1beta1.Dataset" + } + ], + "resultType": ".google.cloud.automl.v1beta1.Dataset", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.CreateDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_GetDataset_async", + "title": "automl getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets a dataset.", + "canonical": true, + "file": "auto_ml.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.Dataset", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ListDatasets_async", + "title": "automl listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists datasets in a project.", + "canonical": true, + "file": "auto_ml.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListDatasets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ListDatasetsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListDatasets", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_UpdateDataset_async", + "title": "automl updateDataset Sample", + "origin": "API_DEFINITION", + "description": " Updates a dataset.", + "canonical": true, + "file": "auto_ml.update_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UpdateDataset", + "async": true, + "parameters": [ + { + "name": "dataset", + "type": ".google.cloud.automl.v1beta1.Dataset" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1beta1.Dataset", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "UpdateDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UpdateDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_DeleteDataset_async", + "title": "automl deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a dataset and all of its contents. Returns empty response in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.", + "canonical": true, + "file": "auto_ml.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.automl.v1beta1.AutoMl.DeleteDataset", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ImportData_async", + "title": "automl importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into a dataset. For Tables this method can only be called on an empty Dataset. For Tables: * A [schema_inference_version][google.cloud.automl.v1beta1.InputConfig.params] parameter must be explicitly set. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "input_config", + "type": ".google.cloud.automl.v1beta1.InputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ImportData", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ExportData_async", + "title": "automl exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports dataset's data to the provided output location. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1beta1.OutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ExportData", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_GetAnnotationSpec_async", + "title": "automl getAnnotationSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets an annotation spec.", + "canonical": true, + "file": "auto_ml.get_annotation_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetAnnotationSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.AnnotationSpec", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "GetAnnotationSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetAnnotationSpec", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_GetTableSpec_async", + "title": "automl getTableSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets a table spec.", + "canonical": true, + "file": "auto_ml.get_table_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTableSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetTableSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1beta1.TableSpec", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "GetTableSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetTableSpec", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ListTableSpecs_async", + "title": "automl listTableSpecs Sample", + "origin": "API_DEFINITION", + "description": " Lists table specs in a dataset.", + "canonical": true, + "file": "auto_ml.list_table_specs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTableSpecs", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListTableSpecs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ListTableSpecsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ListTableSpecs", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListTableSpecs", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_UpdateTableSpec_async", + "title": "automl updateTableSpec Sample", + "origin": "API_DEFINITION", + "description": " Updates a table spec.", + "canonical": true, + "file": "auto_ml.update_table_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTableSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UpdateTableSpec", + "async": true, + "parameters": [ + { + "name": "table_spec", + "type": ".google.cloud.automl.v1beta1.TableSpec" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1beta1.TableSpec", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "UpdateTableSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UpdateTableSpec", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_GetColumnSpec_async", + "title": "automl getColumnSpec Sample", + "origin": "API_DEFINITION", + "description": " Gets a column spec.", + "canonical": true, + "file": "auto_ml.get_column_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetColumnSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetColumnSpec", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ColumnSpec", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "GetColumnSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetColumnSpec", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ListColumnSpecs_async", + "title": "automl listColumnSpecs Sample", + "origin": "API_DEFINITION", + "description": " Lists column specs in a table spec.", + "canonical": true, + "file": "auto_ml.list_column_specs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListColumnSpecs", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "field_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ListColumnSpecsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ListColumnSpecs", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_UpdateColumnSpec_async", + "title": "automl updateColumnSpec Sample", + "origin": "API_DEFINITION", + "description": " Updates a column spec.", + "canonical": true, + "file": "auto_ml.update_column_spec.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateColumnSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UpdateColumnSpec", + "async": true, + "parameters": [ + { + "name": "column_spec", + "type": ".google.cloud.automl.v1beta1.ColumnSpec" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ColumnSpec", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "UpdateColumnSpec", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UpdateColumnSpec", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_CreateModel_async", + "title": "automl createModel Sample", + "origin": "API_DEFINITION", + "description": " Creates a model. Returns a Model in the [response][google.longrunning.Operation.response] field when it completes. When you create a model, several model evaluations are created for it: a global evaluation, and one evaluation for each annotation spec.", + "canonical": true, + "file": "auto_ml.create_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.CreateModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "model", + "type": ".google.cloud.automl.v1beta1.Model" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "CreateModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.CreateModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_GetModel_async", + "title": "automl getModel Sample", + "origin": "API_DEFINITION", + "description": " Gets a model.", + "canonical": true, + "file": "auto_ml.get_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.Model", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "GetModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ListModels_async", + "title": "automl listModels Sample", + "origin": "API_DEFINITION", + "description": " Lists models.", + "canonical": true, + "file": "auto_ml.list_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModels", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ListModelsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ListModels", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListModels", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_DeleteModel_async", + "title": "automl deleteModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes a model. Returns `google.protobuf.Empty` in the [response][google.longrunning.Operation.response] field when it completes, and `delete_details` in the [metadata][google.longrunning.Operation.metadata] field.", + "canonical": true, + "file": "auto_ml.delete_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.DeleteModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "DeleteModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.DeleteModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_DeployModel_async", + "title": "automl deployModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys a model. If a model is already deployed, deploying it with the same parameters has no effect. Deploying with different parametrs (as e.g. changing [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 , 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.", + "canonical": true, + "file": "auto_ml.deploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.DeployModel", + "async": true, + "parameters": [ + { + "name": "image_object_detection_model_deployment_metadata", + "type": ".google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata" + }, + { + "name": "image_classification_model_deployment_metadata", + "type": ".google.cloud.automl.v1beta1.ImageClassificationModelDeploymentMetadata" + }, + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "DeployModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.DeployModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_UndeployModel_async", + "title": "automl undeployModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys a model. If the model is not deployed this method has no effect. Only applicable for Text Classification, Image Object Detection and Tables; all other domains manage deployment automatically. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.undeploy_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UndeployModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "UndeployModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.UndeployModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ExportModel_async", + "title": "automl exportModel Sample", + "origin": "API_DEFINITION", + "description": " Exports a trained, \"export-able\", model to a user specified Google Cloud Storage location. A model is considered export-able if and only if it has an export format defined for it in [ModelExportOutputConfig][google.cloud.automl.v1beta1.ModelExportOutputConfig]. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.export_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ExportModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1beta1.ModelExportOutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ExportModel", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ExportModel", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ExportEvaluatedExamples_async", + "title": "automl exportEvaluatedExamples Sample", + "origin": "API_DEFINITION", + "description": " Exports examples on which the model was evaluated (i.e. which were in the TEST set of the dataset the model was created from), together with their ground truth annotations and the annotations created (predicted) by the model. The examples, ground truth and predictions are exported in the state they were at the moment the model was evaluated. This export is available only for 30 days since the model evaluation is created. Currently only available for Tables. Returns an empty response in the [response][google.longrunning.Operation.response] field when it completes.", + "canonical": true, + "file": "auto_ml.export_evaluated_examples.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportEvaluatedExamples", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ExportEvaluatedExamples", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1beta1.ExportEvaluatedExamplesOutputConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ExportEvaluatedExamples", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ExportEvaluatedExamples", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_GetModelEvaluation_async", + "title": "automl getModelEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets a model evaluation.", + "canonical": true, + "file": "auto_ml.get_model_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetModelEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ModelEvaluation", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "GetModelEvaluation", + "fullName": "google.cloud.automl.v1beta1.AutoMl.GetModelEvaluation", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_AutoMl_ListModelEvaluations_async", + "title": "automl listModelEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Lists model evaluations.", + "canonical": true, + "file": "auto_ml.list_model_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.automl.v1beta1.ListModelEvaluationsResponse", + "client": { + "shortName": "AutoMlClient", + "fullName": "google.cloud.automl.v1beta1.AutoMlClient" + }, + "method": { + "shortName": "ListModelEvaluations", + "fullName": "google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations", + "service": { + "shortName": "AutoMl", + "fullName": "google.cloud.automl.v1beta1.AutoMl" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_PredictionService_Predict_async", + "title": "automl predict Sample", + "origin": "API_DEFINITION", + "description": " Perform an online prediction. The prediction result will be directly returned in the response. Available for following ML problems, and their expected request payloads: * Image Classification - Image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. * Image Object Detection - Image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB. * Text Classification - TextSnippet, content up to 60,000 characters, UTF-8 encoded. * Text Extraction - TextSnippet, content up to 30,000 characters, UTF-8 NFC encoded. * Translation - TextSnippet, content up to 25,000 characters, UTF-8 encoded. * Tables - Row, with column values matching the columns of the model, up to 5MB. Not available for FORECASTING [prediction_type][google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type]. * Text Sentiment - TextSnippet, content up 500 characters, UTF-8 encoded.", + "canonical": true, + "file": "prediction_service.predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "Predict", + "fullName": "google.cloud.automl.v1beta1.PredictionService.Predict", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "payload", + "type": ".google.cloud.automl.v1beta1.ExamplePayload" + }, + { + "name": "params", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.cloud.automl.v1beta1.PredictResponse", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.automl.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "Predict", + "fullName": "google.cloud.automl.v1beta1.PredictionService.Predict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.automl.v1beta1.PredictionService" + } + } + } + }, + { + "regionTag": "automl_v1beta1_generated_PredictionService_BatchPredict_async", + "title": "automl batchPredict Sample", + "origin": "API_DEFINITION", + "description": " 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. Available for following ML problems: * Image Classification * Image Object Detection * Video Classification * Video Object Tracking * Text Extraction * Tables", + "canonical": true, + "file": "prediction_service.batch_predict.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 127, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchPredict", + "fullName": "google.cloud.automl.v1beta1.PredictionService.BatchPredict", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "input_config", + "type": ".google.cloud.automl.v1beta1.BatchPredictInputConfig" + }, + { + "name": "output_config", + "type": ".google.cloud.automl.v1beta1.BatchPredictOutputConfig" + }, + { + "name": "params", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "PredictionServiceClient", + "fullName": "google.cloud.automl.v1beta1.PredictionServiceClient" + }, + "method": { + "shortName": "BatchPredict", + "fullName": "google.cloud.automl.v1beta1.PredictionService.BatchPredict", + "service": { + "shortName": "PredictionService", + "fullName": "google.cloud.automl.v1beta1.PredictionService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-automl/src/v1/auto_ml_client.ts b/packages/google-cloud-automl/src/v1/auto_ml_client.ts index 42f4f898486..a40ced027cc 100644 --- a/packages/google-cloud-automl/src/v1/auto_ml_client.ts +++ b/packages/google-cloud-automl/src/v1/auto_ml_client.ts @@ -577,9 +577,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.get_dataset.js * region_tag:automl_v1_generated_AutoMl_GetDataset_async @@ -662,9 +661,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.update_dataset.js * region_tag:automl_v1_generated_AutoMl_UpdateDataset_async @@ -747,9 +745,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.AnnotationSpec | AnnotationSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.AnnotationSpec|AnnotationSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.get_annotation_spec.js * region_tag:automl_v1_generated_AutoMl_GetAnnotationSpec_async @@ -838,9 +835,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.get_model.js * region_tag:automl_v1_generated_AutoMl_GetModel_async @@ -923,9 +919,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.update_model.js * region_tag:automl_v1_generated_AutoMl_UpdateModel_async @@ -1006,9 +1001,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.ModelEvaluation | ModelEvaluation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.ModelEvaluation|ModelEvaluation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.get_model_evaluation.js * region_tag:automl_v1_generated_AutoMl_GetModelEvaluation_async @@ -1103,8 +1097,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.create_dataset.js * region_tag:automl_v1_generated_AutoMl_CreateDataset_async @@ -1199,8 +1192,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.create_dataset.js * region_tag:automl_v1_generated_AutoMl_CreateDataset_async @@ -1231,9 +1223,9 @@ export class AutoMlClient { /** * Deletes a dataset and all of its contents. * Returns empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes, + * {@link protos.google.longrunning.Operation.response|response} field when it completes, * and `delete_details` in the - * {@link google.longrunning.Operation.metadata|metadata} field. + * {@link protos.google.longrunning.Operation.metadata|metadata} field. * * @param {Object} request * The request object that will be sent. @@ -1245,8 +1237,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.delete_dataset.js * region_tag:automl_v1_generated_AutoMl_DeleteDataset_async @@ -1341,8 +1332,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.delete_dataset.js * region_tag:automl_v1_generated_AutoMl_DeleteDataset_async @@ -1376,10 +1366,10 @@ export class AutoMlClient { * * For Tables: * * A - * {@link google.cloud.automl.v1.InputConfig.params|schema_inference_version} + * {@link protos.google.cloud.automl.v1.InputConfig.params|schema_inference_version} * parameter must be explicitly set. * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -1395,8 +1385,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.import_data.js * region_tag:automl_v1_generated_AutoMl_ImportData_async @@ -1491,8 +1480,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.import_data.js * region_tag:automl_v1_generated_AutoMl_ImportData_async @@ -1523,7 +1511,7 @@ export class AutoMlClient { /** * Exports dataset's data to the provided output location. * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -1537,8 +1525,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.export_data.js * region_tag:automl_v1_generated_AutoMl_ExportData_async @@ -1633,8 +1620,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.export_data.js * region_tag:automl_v1_generated_AutoMl_ExportData_async @@ -1664,7 +1650,7 @@ export class AutoMlClient { } /** * Creates a model. - * Returns a Model in the {@link google.longrunning.Operation.response|response} + * Returns a Model in the {@link protos.google.longrunning.Operation.response|response} * field when it completes. * When you create a model, several model evaluations are created for it: * a global evaluation, and one evaluation for each annotation spec. @@ -1681,8 +1667,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.create_model.js * region_tag:automl_v1_generated_AutoMl_CreateModel_async @@ -1777,8 +1762,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.create_model.js * region_tag:automl_v1_generated_AutoMl_CreateModel_async @@ -1809,9 +1793,9 @@ export class AutoMlClient { /** * Deletes a model. * Returns `google.protobuf.Empty` in the - * {@link google.longrunning.Operation.response|response} field when it completes, + * {@link protos.google.longrunning.Operation.response|response} field when it completes, * and `delete_details` in the - * {@link google.longrunning.Operation.metadata|metadata} field. + * {@link protos.google.longrunning.Operation.metadata|metadata} field. * * @param {Object} request * The request object that will be sent. @@ -1823,8 +1807,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.delete_model.js * region_tag:automl_v1_generated_AutoMl_DeleteModel_async @@ -1919,8 +1902,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.delete_model.js * region_tag:automl_v1_generated_AutoMl_DeleteModel_async @@ -1952,14 +1934,14 @@ export class AutoMlClient { * Deploys a model. If a model is already deployed, deploying it with the * same parameters has no effect. Deploying with different parametrs * (as e.g. changing - * {@link google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number|node_number}) + * {@link protos.google.cloud.automl.v1p1beta.ImageObjectDetectionModelDeploymentMetadata.node_number|node_number}) * will reset the deployment state without pausing the model's availability. * * Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage * deployment automatically. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -1975,8 +1957,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.deploy_model.js * region_tag:automl_v1_generated_AutoMl_DeployModel_async @@ -2071,8 +2052,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.deploy_model.js * region_tag:automl_v1_generated_AutoMl_DeployModel_async @@ -2107,7 +2087,7 @@ export class AutoMlClient { * all other domains manage deployment automatically. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -2119,8 +2099,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.undeploy_model.js * region_tag:automl_v1_generated_AutoMl_UndeployModel_async @@ -2215,8 +2194,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.undeploy_model.js * region_tag:automl_v1_generated_AutoMl_UndeployModel_async @@ -2248,10 +2226,10 @@ export class AutoMlClient { * Exports a trained, "export-able", model to a user specified Google Cloud * Storage location. A model is considered export-able if and only if it has * an export format defined for it in - * {@link google.cloud.automl.v1.ModelExportOutputConfig|ModelExportOutputConfig}. + * {@link protos.google.cloud.automl.v1.ModelExportOutputConfig|ModelExportOutputConfig}. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -2265,8 +2243,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.export_model.js * region_tag:automl_v1_generated_AutoMl_ExportModel_async @@ -2361,8 +2338,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.export_model.js * region_tag:automl_v1_generated_AutoMl_ExportModel_async @@ -2411,19 +2387,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. + * {@link protos.google.cloud.automl.v1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1.Dataset | Dataset}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1.Dataset|Dataset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasets( @@ -2515,18 +2490,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. + * {@link protos.google.cloud.automl.v1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1.Dataset | Dataset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1.Dataset|Dataset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasetsStream( @@ -2573,17 +2547,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. + * {@link protos.google.cloud.automl.v1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1.Dataset | Dataset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1.Dataset|Dataset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.list_datasets.js * region_tag:automl_v1_generated_AutoMl_ListDatasets_async @@ -2631,19 +2604,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListModels|AutoMl.ListModels} call. + * {@link protos.google.cloud.automl.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListModels|AutoMl.ListModels} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1.Model | Model}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModels( @@ -2734,18 +2706,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListModels|AutoMl.ListModels} call. + * {@link protos.google.cloud.automl.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListModels|AutoMl.ListModels} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelsStream( @@ -2793,17 +2764,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListModels|AutoMl.ListModels} call. + * {@link protos.google.cloud.automl.v1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListModels|AutoMl.ListModels} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.list_models.js * region_tag:automl_v1_generated_AutoMl_ListModels_async @@ -2855,19 +2825,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained via - * {@link google.cloud.automl.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. + * {@link protos.google.cloud.automl.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1.ModelEvaluation | ModelEvaluation}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1.ModelEvaluation|ModelEvaluation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluations( @@ -2970,18 +2939,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained via - * {@link google.cloud.automl.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. + * {@link protos.google.cloud.automl.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1.ModelEvaluation | ModelEvaluation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1.ModelEvaluation|ModelEvaluation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationsStream( @@ -3033,17 +3001,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained via - * {@link google.cloud.automl.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. + * {@link protos.google.cloud.automl.v1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1.ModelEvaluation | ModelEvaluation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1.ModelEvaluation|ModelEvaluation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/auto_ml.list_model_evaluations.js * region_tag:automl_v1_generated_AutoMl_ListModelEvaluations_async diff --git a/packages/google-cloud-automl/src/v1/prediction_service_client.ts b/packages/google-cloud-automl/src/v1/prediction_service_client.ts index 2610f9d47ed..df84e16bbb3 100644 --- a/packages/google-cloud-automl/src/v1/prediction_service_client.ts +++ b/packages/google-cloud-automl/src/v1/prediction_service_client.ts @@ -493,16 +493,15 @@ export class PredictionServiceClient { * * `feature_importance` * : (boolean) Whether - * {@link google.cloud.automl.v1.TablesModelColumnInfo.feature_importance|feature_importance} + * {@link protos.google.cloud.automl.v1.TablesModelColumnInfo.feature_importance|feature_importance} * is populated in the returned list of - * {@link google.cloud.automl.v1.TablesAnnotation|TablesAnnotation} + * {@link protos.google.cloud.automl.v1.TablesAnnotation|TablesAnnotation} * objects. The default is false. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1.PredictResponse | PredictResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1.PredictResponse|PredictResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/prediction_service.predict.js * region_tag:automl_v1_generated_PredictionService_Predict_async @@ -575,12 +574,12 @@ export class PredictionServiceClient { } /** - * Perform a batch prediction. Unlike the online {@link google.cloud.automl.v1.PredictionService.Predict|Predict}, batch + * Perform a batch prediction. Unlike the online {@link protos.google.cloud.automl.v1.PredictionService.Predict|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 {@link google.longrunning.Operations.GetOperation|GetOperation} - * method. Once the operation is done, {@link google.cloud.automl.v1.BatchPredictResult|BatchPredictResult} is returned in - * the {@link google.longrunning.Operation.response|response} field. + * result via {@link protos.google.longrunning.Operations.GetOperation|GetOperation} + * method. Once the operation is done, {@link protos.google.cloud.automl.v1.BatchPredictResult|BatchPredictResult} is returned in + * the {@link protos.google.longrunning.Operation.response|response} field. * Available for following ML scenarios: * * * AutoML Vision Classification @@ -691,8 +690,7 @@ export class PredictionServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/prediction_service.batch_predict.js * region_tag:automl_v1_generated_PredictionService_BatchPredict_async @@ -787,8 +785,7 @@ export class PredictionServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/prediction_service.batch_predict.js * region_tag:automl_v1_generated_PredictionService_BatchPredict_async diff --git a/packages/google-cloud-automl/src/v1beta1/auto_ml_client.ts b/packages/google-cloud-automl/src/v1beta1/auto_ml_client.ts index 045827ed7b3..47f66bd76b6 100644 --- a/packages/google-cloud-automl/src/v1beta1/auto_ml_client.ts +++ b/packages/google-cloud-automl/src/v1beta1/auto_ml_client.ts @@ -597,9 +597,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.create_dataset.js * region_tag:automl_v1beta1_generated_AutoMl_CreateDataset_async @@ -688,9 +687,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.get_dataset.js * region_tag:automl_v1beta1_generated_AutoMl_GetDataset_async @@ -775,9 +773,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.Dataset | Dataset}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.Dataset|Dataset}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.update_dataset.js * region_tag:automl_v1beta1_generated_AutoMl_UpdateDataset_async @@ -866,9 +863,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.AnnotationSpec | AnnotationSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.AnnotationSpec|AnnotationSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.get_annotation_spec.js * region_tag:automl_v1beta1_generated_AutoMl_GetAnnotationSpec_async @@ -959,9 +955,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.TableSpec | TableSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.TableSpec|TableSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.get_table_spec.js * region_tag:automl_v1beta1_generated_AutoMl_GetTableSpec_async @@ -1052,9 +1047,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.TableSpec | TableSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.TableSpec|TableSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.update_table_spec.js * region_tag:automl_v1beta1_generated_AutoMl_UpdateTableSpec_async @@ -1145,9 +1139,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.ColumnSpec | ColumnSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.ColumnSpec|ColumnSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.get_column_spec.js * region_tag:automl_v1beta1_generated_AutoMl_GetColumnSpec_async @@ -1238,9 +1231,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.ColumnSpec | ColumnSpec}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.ColumnSpec|ColumnSpec}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.update_column_spec.js * region_tag:automl_v1beta1_generated_AutoMl_UpdateColumnSpec_async @@ -1329,9 +1321,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.Model | Model}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.Model|Model}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.get_model.js * region_tag:automl_v1beta1_generated_AutoMl_GetModel_async @@ -1414,9 +1405,8 @@ export class AutoMlClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.ModelEvaluation | ModelEvaluation}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.ModelEvaluation|ModelEvaluation}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.get_model_evaluation.js * region_tag:automl_v1beta1_generated_AutoMl_GetModelEvaluation_async @@ -1499,9 +1489,9 @@ export class AutoMlClient { /** * Deletes a dataset and all of its contents. * Returns empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes, + * {@link protos.google.longrunning.Operation.response|response} field when it completes, * and `delete_details` in the - * {@link google.longrunning.Operation.metadata|metadata} field. + * {@link protos.google.longrunning.Operation.metadata|metadata} field. * * @param {Object} request * The request object that will be sent. @@ -1513,8 +1503,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.delete_dataset.js * region_tag:automl_v1beta1_generated_AutoMl_DeleteDataset_async @@ -1609,8 +1598,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.delete_dataset.js * region_tag:automl_v1beta1_generated_AutoMl_DeleteDataset_async @@ -1644,10 +1632,10 @@ export class AutoMlClient { * * For Tables: * * A - * {@link google.cloud.automl.v1beta1.InputConfig.params|schema_inference_version} + * {@link protos.google.cloud.automl.v1beta1.InputConfig.params|schema_inference_version} * parameter must be explicitly set. * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -1663,8 +1651,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.import_data.js * region_tag:automl_v1beta1_generated_AutoMl_ImportData_async @@ -1759,8 +1746,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.import_data.js * region_tag:automl_v1beta1_generated_AutoMl_ImportData_async @@ -1791,7 +1777,7 @@ export class AutoMlClient { /** * Exports dataset's data to the provided output location. * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -1805,8 +1791,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.export_data.js * region_tag:automl_v1beta1_generated_AutoMl_ExportData_async @@ -1901,8 +1886,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.export_data.js * region_tag:automl_v1beta1_generated_AutoMl_ExportData_async @@ -1932,7 +1916,7 @@ export class AutoMlClient { } /** * Creates a model. - * Returns a Model in the {@link google.longrunning.Operation.response|response} + * Returns a Model in the {@link protos.google.longrunning.Operation.response|response} * field when it completes. * When you create a model, several model evaluations are created for it: * a global evaluation, and one evaluation for each annotation spec. @@ -1949,8 +1933,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.create_model.js * region_tag:automl_v1beta1_generated_AutoMl_CreateModel_async @@ -2045,8 +2028,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.create_model.js * region_tag:automl_v1beta1_generated_AutoMl_CreateModel_async @@ -2077,9 +2059,9 @@ export class AutoMlClient { /** * Deletes a model. * Returns `google.protobuf.Empty` in the - * {@link google.longrunning.Operation.response|response} field when it completes, + * {@link protos.google.longrunning.Operation.response|response} field when it completes, * and `delete_details` in the - * {@link google.longrunning.Operation.metadata|metadata} field. + * {@link protos.google.longrunning.Operation.metadata|metadata} field. * * @param {Object} request * The request object that will be sent. @@ -2091,8 +2073,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.delete_model.js * region_tag:automl_v1beta1_generated_AutoMl_DeleteModel_async @@ -2187,8 +2168,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.delete_model.js * region_tag:automl_v1beta1_generated_AutoMl_DeleteModel_async @@ -2221,14 +2201,14 @@ export class AutoMlClient { * same parameters has no effect. Deploying with different parametrs * (as e.g. changing * - * {@link google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata.node_number|node_number}) + * {@link protos.google.cloud.automl.v1beta1.ImageObjectDetectionModelDeploymentMetadata.node_number|node_number}) * will reset the deployment state without pausing the model's availability. * * Only applicable for Text Classification, Image Object Detection , Tables, and Image Segmentation; all other domains manage * deployment automatically. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -2244,8 +2224,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.deploy_model.js * region_tag:automl_v1beta1_generated_AutoMl_DeployModel_async @@ -2340,8 +2319,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.deploy_model.js * region_tag:automl_v1beta1_generated_AutoMl_DeployModel_async @@ -2376,7 +2354,7 @@ export class AutoMlClient { * all other domains manage deployment automatically. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -2388,8 +2366,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.undeploy_model.js * region_tag:automl_v1beta1_generated_AutoMl_UndeployModel_async @@ -2484,8 +2461,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.undeploy_model.js * region_tag:automl_v1beta1_generated_AutoMl_UndeployModel_async @@ -2518,10 +2494,10 @@ export class AutoMlClient { * Storage location. A model is considered export-able if and only if it has * an export format defined for it in * - * {@link google.cloud.automl.v1beta1.ModelExportOutputConfig|ModelExportOutputConfig}. + * {@link protos.google.cloud.automl.v1beta1.ModelExportOutputConfig|ModelExportOutputConfig}. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -2535,8 +2511,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.export_model.js * region_tag:automl_v1beta1_generated_AutoMl_ExportModel_async @@ -2631,8 +2606,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.export_model.js * region_tag:automl_v1beta1_generated_AutoMl_ExportModel_async @@ -2674,7 +2648,7 @@ export class AutoMlClient { * Currently only available for Tables. * * Returns an empty response in the - * {@link google.longrunning.Operation.response|response} field when it completes. + * {@link protos.google.longrunning.Operation.response|response} field when it completes. * * @param {Object} request * The request object that will be sent. @@ -2689,8 +2663,7 @@ export class AutoMlClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.export_evaluated_examples.js * region_tag:automl_v1beta1_generated_AutoMl_ExportEvaluatedExamples_async @@ -2789,8 +2762,7 @@ export class AutoMlClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.export_evaluated_examples.js * region_tag:automl_v1beta1_generated_AutoMl_ExportEvaluatedExamples_async @@ -2840,19 +2812,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. + * {@link protos.google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1beta1.Dataset | Dataset}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1beta1.Dataset|Dataset}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasets( @@ -2951,18 +2922,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. + * {@link protos.google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1beta1.Dataset | Dataset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1beta1.Dataset|Dataset} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDatasetsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDatasetsStream( @@ -3010,17 +2980,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. + * {@link protos.google.cloud.automl.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListDatasets|AutoMl.ListDatasets} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1beta1.Dataset | Dataset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1beta1.Dataset|Dataset}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.list_datasets.js * region_tag:automl_v1beta1_generated_AutoMl_ListDatasets_async @@ -3063,19 +3032,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained from the - * {@link google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token|ListTableSpecsResponse.next_page_token} field of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListTableSpecs|AutoMl.ListTableSpecs} call. + * {@link protos.google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token|ListTableSpecsResponse.next_page_token} field of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListTableSpecs|AutoMl.ListTableSpecs} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1beta1.TableSpec | TableSpec}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1beta1.TableSpec|TableSpec}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listTableSpecsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTableSpecs( @@ -3169,18 +3137,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained from the - * {@link google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token|ListTableSpecsResponse.next_page_token} field of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListTableSpecs|AutoMl.ListTableSpecs} call. + * {@link protos.google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token|ListTableSpecsResponse.next_page_token} field of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListTableSpecs|AutoMl.ListTableSpecs} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1beta1.TableSpec | TableSpec} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1beta1.TableSpec|TableSpec} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listTableSpecsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listTableSpecsStream( @@ -3223,17 +3190,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained from the - * {@link google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token|ListTableSpecsResponse.next_page_token} field of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListTableSpecs|AutoMl.ListTableSpecs} call. + * {@link protos.google.cloud.automl.v1beta1.ListTableSpecsResponse.next_page_token|ListTableSpecsResponse.next_page_token} field of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListTableSpecs|AutoMl.ListTableSpecs} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1beta1.TableSpec | TableSpec}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1beta1.TableSpec|TableSpec}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.list_table_specs.js * region_tag:automl_v1beta1_generated_AutoMl_ListTableSpecs_async @@ -3276,19 +3242,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained from the - * {@link google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token|ListColumnSpecsResponse.next_page_token} field of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs|AutoMl.ListColumnSpecs} call. + * {@link protos.google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token|ListColumnSpecsResponse.next_page_token} field of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs|AutoMl.ListColumnSpecs} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1beta1.ColumnSpec | ColumnSpec}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1beta1.ColumnSpec|ColumnSpec}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listColumnSpecsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listColumnSpecs( @@ -3382,18 +3347,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained from the - * {@link google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token|ListColumnSpecsResponse.next_page_token} field of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs|AutoMl.ListColumnSpecs} call. + * {@link protos.google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token|ListColumnSpecsResponse.next_page_token} field of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs|AutoMl.ListColumnSpecs} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1beta1.ColumnSpec | ColumnSpec} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1beta1.ColumnSpec|ColumnSpec} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listColumnSpecsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listColumnSpecsStream( @@ -3436,17 +3400,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained from the - * {@link google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token|ListColumnSpecsResponse.next_page_token} field of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs|AutoMl.ListColumnSpecs} call. + * {@link protos.google.cloud.automl.v1beta1.ListColumnSpecsResponse.next_page_token|ListColumnSpecsResponse.next_page_token} field of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListColumnSpecs|AutoMl.ListColumnSpecs} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1beta1.ColumnSpec | ColumnSpec}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1beta1.ColumnSpec|ColumnSpec}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.list_column_specs.js * region_tag:automl_v1beta1_generated_AutoMl_ListColumnSpecs_async @@ -3494,19 +3457,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListModels|AutoMl.ListModels} call. + * {@link protos.google.cloud.automl.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListModels|AutoMl.ListModels} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1beta1.Model | Model}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1beta1.Model|Model}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModels( @@ -3599,18 +3561,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListModels|AutoMl.ListModels} call. + * {@link protos.google.cloud.automl.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListModels|AutoMl.ListModels} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1beta1.Model | Model} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1beta1.Model|Model} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelsStream( @@ -3658,17 +3619,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListModels|AutoMl.ListModels} call. + * {@link protos.google.cloud.automl.v1beta1.ListModelsResponse.next_page_token|ListModelsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListModels|AutoMl.ListModels} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1beta1.Model | Model}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1beta1.Model|Model}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.list_models.js * region_tag:automl_v1beta1_generated_AutoMl_ListModels_async @@ -3720,19 +3680,18 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. + * {@link protos.google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is Array of {@link google.cloud.automl.v1beta1.ModelEvaluation | ModelEvaluation}. + * The first element of the array is Array of {@link protos.google.cloud.automl.v1beta1.ModelEvaluation|ModelEvaluation}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluations( @@ -3835,18 +3794,17 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. + * {@link protos.google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} - * An object stream which emits an object representing {@link google.cloud.automl.v1beta1.ModelEvaluation | ModelEvaluation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.automl.v1beta1.ModelEvaluation|ModelEvaluation} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listModelEvaluationsAsync()` * method described below for async iteration which you can stop as needed. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listModelEvaluationsStream( @@ -3898,17 +3856,16 @@ export class AutoMlClient { * @param {string} request.pageToken * A token identifying a page of results for the server to return. * Typically obtained via - * {@link google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous - * {@link google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. + * {@link protos.google.cloud.automl.v1beta1.ListModelEvaluationsResponse.next_page_token|ListModelEvaluationsResponse.next_page_token} of the previous + * {@link protos.google.cloud.automl.v1beta1.AutoMl.ListModelEvaluations|AutoMl.ListModelEvaluations} call. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} - * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). + * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing - * {@link google.cloud.automl.v1beta1.ModelEvaluation | ModelEvaluation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.automl.v1beta1.ModelEvaluation|ModelEvaluation}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/auto_ml.list_model_evaluations.js * region_tag:automl_v1beta1_generated_AutoMl_ListModelEvaluations_async diff --git a/packages/google-cloud-automl/src/v1beta1/prediction_service_client.ts b/packages/google-cloud-automl/src/v1beta1/prediction_service_client.ts index 873643eeacf..2df4672508d 100644 --- a/packages/google-cloud-automl/src/v1beta1/prediction_service_client.ts +++ b/packages/google-cloud-automl/src/v1beta1/prediction_service_client.ts @@ -436,7 +436,7 @@ export class PredictionServiceClient { * * Tables - Row, with column values matching the columns of the model, * up to 5MB. Not available for FORECASTING * - * {@link google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type|prediction_type}. + * {@link protos.google.cloud.automl.v1beta1.TablesModelMetadata.prediction_type|prediction_type}. * * Text Sentiment - TextSnippet, content up 500 characters, UTF-8 * encoded. * @@ -471,9 +471,8 @@ export class PredictionServiceClient { * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. - * The first element of the array is an object representing {@link google.cloud.automl.v1beta1.PredictResponse | PredictResponse}. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) + * The first element of the array is an object representing {@link protos.google.cloud.automl.v1beta1.PredictResponse|PredictResponse}. + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/prediction_service.predict.js * region_tag:automl_v1beta1_generated_PredictionService_Predict_async @@ -546,12 +545,12 @@ export class PredictionServiceClient { } /** - * Perform a batch prediction. Unlike the online {@link google.cloud.automl.v1beta1.PredictionService.Predict|Predict}, batch + * Perform a batch prediction. Unlike the online {@link protos.google.cloud.automl.v1beta1.PredictionService.Predict|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 {@link google.longrunning.Operations.GetOperation|GetOperation} - * method. Once the operation is done, {@link google.cloud.automl.v1beta1.BatchPredictResult|BatchPredictResult} is returned in - * the {@link google.longrunning.Operation.response|response} field. + * result via {@link protos.google.longrunning.Operations.GetOperation|GetOperation} + * method. Once the operation is done, {@link protos.google.cloud.automl.v1beta1.BatchPredictResult|BatchPredictResult} is returned in + * the {@link protos.google.longrunning.Operation.response|response} field. * Available for following ML problems: * * Image Classification * * Image Object Detection @@ -645,8 +644,7 @@ export class PredictionServiceClient { * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/prediction_service.batch_predict.js * region_tag:automl_v1beta1_generated_PredictionService_BatchPredict_async @@ -741,8 +739,7 @@ export class PredictionServiceClient { * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. - * Please see the - * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) + * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/prediction_service.batch_predict.js * region_tag:automl_v1beta1_generated_PredictionService_BatchPredict_async