Stay organized with collections Save and categorize content based on your preferences.

Vertex AI: Node.js Client

release level npm version

Google Cloud Vertex AI is an integrated suite of machine learning tools and services for building and using ML models with AutoML or custom code. It offers both novices and experts the best workbench for the entire machine learning development lifecycle.

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Vertex AI API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/aiplatform

Using the client library

const {DatasetServiceClient} = require('@google-cloud/aiplatform');
const client = new DatasetServiceClient();

// Do something with DatasetServiceClient.
console.info(client);

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Batch-create-features-samplesource codeOpen in Cloud Shell
Batch-read-feature-values-samplesource codeOpen in Cloud Shell
Cancel-batch-prediction-jobsource codeOpen in Cloud Shell
Cancel-custom-jobsource codeOpen in Cloud Shell
Create-batch-prediction-job-text-classificationsource codeOpen in Cloud Shell
Create-batch-prediction-job-text-entity-extractionsource codeOpen in Cloud Shell
Create-batch-prediction-job-text-sentiment-analysissource codeOpen in Cloud Shell
Create-batch-prediction-job-video-action-recognitionsource codeOpen in Cloud Shell
Create-batch-prediction-job-video-classificationsource codeOpen in Cloud Shell
Create-batch-prediction-job-video-object-trackingsource codeOpen in Cloud Shell
Create-custom-jobsource codeOpen in Cloud Shell
Create-dataset-imagesource codeOpen in Cloud Shell
Create-dataset-tabular-bigquerysource codeOpen in Cloud Shell
Create-dataset-tabular-gcssource codeOpen in Cloud Shell
Create-dataset-textsource codeOpen in Cloud Shell
Create-dataset-videosource codeOpen in Cloud Shell
Create-datasetsource codeOpen in Cloud Shell
Create-endpointsource codeOpen in Cloud Shell
Create-entity-type-monitoring-samplesource codeOpen in Cloud Shell
Create-entity-type-samplesource codeOpen in Cloud Shell
Create-feature-samplesource codeOpen in Cloud Shell
Create-featurestore-fixed-nodes-samplesource codeOpen in Cloud Shell
Create-featurestore-samplesource codeOpen in Cloud Shell
Create-hyperparameter-tuning-jobsource codeOpen in Cloud Shell
Create-training-pipeline-image-classificationsource codeOpen in Cloud Shell
Create-training-pipeline-image-object-detectionsource codeOpen in Cloud Shell
Create-training-pipeline-tabular-classificationsource codeOpen in Cloud Shell
Create-training-pipeline-tabular-regressionsource codeOpen in Cloud Shell
Create-training-pipeline-text-classificationsource codeOpen in Cloud Shell
Create-training-pipeline-text-entity-extractionsource codeOpen in Cloud Shell
Create-training-pipeline-text-sentiment-analysissource codeOpen in Cloud Shell
Create-training-pipeline-video-action-recognitionsource codeOpen in Cloud Shell
Create-training-pipeline-video-classificationsource codeOpen in Cloud Shell
Create-training-pipeline-video-object-trackingsource codeOpen in Cloud Shell
Delete-batch-prediction-jobsource codeOpen in Cloud Shell
Delete-custom-jobsource codeOpen in Cloud Shell
Delete-datasetsource codeOpen in Cloud Shell
Delete-endpointsource codeOpen in Cloud Shell
Delete-entity-type-samplesource codeOpen in Cloud Shell
Delete-export-modelsource codeOpen in Cloud Shell
Delete-feature-samplesource codeOpen in Cloud Shell
Delete-featurestore-samplesource codeOpen in Cloud Shell
Delete-modelsource codeOpen in Cloud Shell
Deploy-model-custom-trained-modelsource codeOpen in Cloud Shell
Deploy-modelsource codeOpen in Cloud Shell
Export-feature-values-samplesource codeOpen in Cloud Shell
Export-feature-values-snapshot-samplesource codeOpen in Cloud Shell
Export-model-tabular-classificationsource codeOpen in Cloud Shell
Export-modelsource codeOpen in Cloud Shell
Get-batch-prediction-jobsource codeOpen in Cloud Shell
Get-custom-jobsource codeOpen in Cloud Shell
Get-entity-type-samplesource codeOpen in Cloud Shell
Get-feature-samplesource codeOpen in Cloud Shell
Get-featurestore-samplesource codeOpen in Cloud Shell
Get-hyperparameter-tuning-jobsource codeOpen in Cloud Shell
Get-model-evaluation-image-classificationsource codeOpen in Cloud Shell
Get-model-evaluation-image-object-detectionsource codeOpen in Cloud Shell
Get-model-evaluation-slicesource codeOpen in Cloud Shell
Get-model-evaluation-tabular-classificationsource codeOpen in Cloud Shell
Get-model-evaluation-tabular-regressionsource codeOpen in Cloud Shell
Get-model-evaluation-text-classificationsource codeOpen in Cloud Shell
Get-model-evaluation-text-entity-extractionsource codeOpen in Cloud Shell
Get-model-evaluation-text-sentiment-analysissource codeOpen in Cloud Shell
Get-model-evaluation-video-action-recognitionsource codeOpen in Cloud Shell
Get-model-evaluation-video-classificationsource codeOpen in Cloud Shell
Get-model-evaluation-video-object-trackingsource codeOpen in Cloud Shell
Get-model-evaluationsource codeOpen in Cloud Shell
Get-modelsource codeOpen in Cloud Shell
Get-training-pipelinesource codeOpen in Cloud Shell
Import-data-image-classificationsource codeOpen in Cloud Shell
Import-data-image-object-detectionsource codeOpen in Cloud Shell
Import-data-text-classification-single-labelsource codeOpen in Cloud Shell
Import-data-text-entity-extractionsource codeOpen in Cloud Shell
Import-data-text-sentiment-analysissource codeOpen in Cloud Shell
Import-data-video-action-recognitionsource codeOpen in Cloud Shell
Import-data-video-classificationsource codeOpen in Cloud Shell
Import-data-video-object-trackingsource codeOpen in Cloud Shell
Import-datasource codeOpen in Cloud Shell
Import-feature-values-samplesource codeOpen in Cloud Shell
List-endpointssource codeOpen in Cloud Shell
List-entity-types-async-samplesource codeOpen in Cloud Shell
List-entity-types-samplesource codeOpen in Cloud Shell
List-entity-types-stream-samplesource codeOpen in Cloud Shell
List-features-async-samplesource codeOpen in Cloud Shell
List-features-samplesource codeOpen in Cloud Shell
List-features-stream-samplesource codeOpen in Cloud Shell
List-featurestores-async-samplesource codeOpen in Cloud Shell
List-featurestores-samplesource codeOpen in Cloud Shell
List-featurestores-stream-samplesource codeOpen in Cloud Shell
List-model-evaluation-slicessource codeOpen in Cloud Shell
Predict-custom-trained-modelsource codeOpen in Cloud Shell
Predict-image-classificationsource codeOpen in Cloud Shell
Predict-image-object-detectionsource codeOpen in Cloud Shell
Predict-tabular-classificationsource codeOpen in Cloud Shell
Predict-tabular-regressionsource codeOpen in Cloud Shell
Predict-text-classificationsource codeOpen in Cloud Shell
Predict-text-entity-extractionsource codeOpen in Cloud Shell
Predict-text-sentiment-analysissource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Read-feature-values-samplesource codeOpen in Cloud Shell
Search-features-async-samplesource codeOpen in Cloud Shell
Search-features-samplesource codeOpen in Cloud Shell
Search-features-stream-samplesource codeOpen in Cloud Shell
Undeploy-modelsource codeOpen in Cloud Shell
Update-entity-type-monitoring-samplesource codeOpen in Cloud Shell
Update-entity-type-samplesource codeOpen in Cloud Shell
Update-feature-samplesource codeOpen in Cloud Shell
Update-featurestore-fixed-nodes-samplesource codeOpen in Cloud Shell
Update-featurestore-samplesource codeOpen in Cloud Shell
Upload-modelsource codeOpen in Cloud Shell

The Vertex AI Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/aiplatform@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE