Package Exports
- @google-cloud/aiplatform
- @google-cloud/aiplatform/build/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@google-cloud/aiplatform) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Vertex AI API: Nodejs Client
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
Vertex AI API client for Node.js
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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Vertex AI API API.
- Set up authentication so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/aiplatformSamples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| generate synthetic data | source code |
| create dataset | source code |
| create dataset version | source code |
| delete dataset | source code |
| delete dataset version | source code |
| delete saved query | source code |
| export data | source code |
| get annotation spec | source code |
| get dataset | source code |
| get dataset version | source code |
| import data | source code |
| list annotations | source code |
| list data items | source code |
| list dataset versions | source code |
| list datasets | source code |
| list saved queries | source code |
| restore dataset version | source code |
| search data items | source code |
| update dataset | source code |
| update dataset version | source code |
| create deployment resource pool | source code |
| delete deployment resource pool | source code |
| get deployment resource pool | source code |
| list deployment resource pools | source code |
| query deployed models | source code |
| update deployment resource pool | source code |
| create endpoint | source code |
| delete endpoint | source code |
| deploy model | source code |
| get endpoint | source code |
| list endpoints | source code |
| mutate deployed model | source code |
| undeploy model | source code |
| update endpoint | source code |
| update endpoint long running | source code |
| evaluate instances | source code |
| create feature online store | source code |
| create feature view | source code |
| delete feature online store | source code |
| delete feature view | source code |
| get feature online store | source code |
| get feature view | source code |
| get feature view sync | source code |
| list feature online stores | source code |
| list feature view syncs | source code |
| list feature views | source code |
| sync feature view | source code |
| update feature online store | source code |
| update feature view | source code |
| feature view direct write | source code |
| fetch feature values | source code |
| generate fetch access token | source code |
| search nearest entities | source code |
| batch create features | source code |
| create feature | source code |
| create feature group | source code |
| delete feature | source code |
| delete feature group | source code |
| get feature | source code |
| get feature group | source code |
| list feature groups | source code |
| list features | source code |
| update feature | source code |
| update feature group | source code |
| read feature values | source code |
| streaming read feature values | source code |
| write feature values | source code |
| batch create features | source code |
| batch read feature values | source code |
| create entity type | source code |
| create feature | source code |
| create featurestore | source code |
| delete entity type | source code |
| delete feature | source code |
| delete feature values | source code |
| delete featurestore | source code |
| export feature values | source code |
| get entity type | source code |
| get feature | source code |
| get featurestore | source code |
| import feature values | source code |
| list entity types | source code |
| list features | source code |
| list featurestores | source code |
| search features | source code |
| update entity type | source code |
| update feature | source code |
| update featurestore | source code |
| create cached content | source code |
| delete cached content | source code |
| get cached content | source code |
| list cached contents | source code |
| update cached content | source code |
| cancel tuning job | source code |
| create tuning job | source code |
| get tuning job | source code |
| list tuning jobs | source code |
| rebase tuned model | source code |
| create index endpoint | source code |
| delete index endpoint | source code |
| deploy index | source code |
| get index endpoint | source code |
| list index endpoints | source code |
| mutate deployed index | source code |
| undeploy index | source code |
| update index endpoint | source code |
| create index | source code |
| delete index | source code |
| get index | source code |
| list indexes | source code |
| remove datapoints | source code |
| update index | source code |
| upsert datapoints | source code |
| cancel batch prediction job | source code |
| cancel custom job | source code |
| cancel data labeling job | source code |
| cancel hyperparameter tuning job | source code |
| cancel nas job | source code |
| create batch prediction job | source code |
| create custom job | source code |
| create data labeling job | source code |
| create hyperparameter tuning job | source code |
| create model deployment monitoring job | source code |
| create nas job | source code |
| delete batch prediction job | source code |
| delete custom job | source code |
| delete data labeling job | source code |
| delete hyperparameter tuning job | source code |
| delete model deployment monitoring job | source code |
| delete nas job | source code |
| get batch prediction job | source code |
| get custom job | source code |
| get data labeling job | source code |
| get hyperparameter tuning job | source code |
| get model deployment monitoring job | source code |
| get nas job | source code |
| get nas trial detail | source code |
| list batch prediction jobs | source code |
| list custom jobs | source code |
| list data labeling jobs | source code |
| list hyperparameter tuning jobs | source code |
| list model deployment monitoring jobs | source code |
| list nas jobs | source code |
| list nas trial details | source code |
| pause model deployment monitoring job | source code |
| resume model deployment monitoring job | source code |
| search model deployment monitoring stats anomalies | source code |
| update model deployment monitoring job | source code |
| compute tokens | source code |
| count tokens | source code |
| find neighbors | source code |
| read index datapoints | source code |
| add context artifacts and executions | source code |
| add context children | source code |
| add execution events | source code |
| create artifact | source code |
| create context | source code |
| create execution | source code |
| create metadata schema | source code |
| create metadata store | source code |
| delete artifact | source code |
| delete context | source code |
| delete execution | source code |
| delete metadata store | source code |
| get artifact | source code |
| get context | source code |
| get execution | source code |
| get metadata schema | source code |
| get metadata store | source code |
| list artifacts | source code |
| list contexts | source code |
| list executions | source code |
| list metadata schemas | source code |
| list metadata stores | source code |
| purge artifacts | source code |
| purge contexts | source code |
| purge executions | source code |
| query artifact lineage subgraph | source code |
| query context lineage subgraph | source code |
| query execution inputs and outputs | source code |
| remove context children | source code |
| update artifact | source code |
| update context | source code |
| update execution | source code |
| batch migrate resources | source code |
| search migratable resources | source code |
| deploy | source code |
| get publisher model | source code |
| batch import evaluated annotations | source code |
| batch import model evaluation slices | source code |
| copy model | source code |
| delete model | source code |
| delete model version | source code |
| export model | source code |
| get model | source code |
| get model evaluation | source code |
| get model evaluation slice | source code |
| import model evaluation | source code |
| list model evaluation slices | source code |
| list model evaluations | source code |
| list model version checkpoints | source code |
| list model versions | source code |
| list models | source code |
| merge version aliases | source code |
| update explanation dataset | source code |
| update model | source code |
| upload model | source code |
| assign notebook runtime | source code |
| create notebook execution job | source code |
| create notebook runtime template | source code |
| delete notebook execution job | source code |
| delete notebook runtime | source code |
| delete notebook runtime template | source code |
| get notebook execution job | source code |
| get notebook runtime | source code |
| get notebook runtime template | source code |
| list notebook execution jobs | source code |
| list notebook runtime templates | source code |
| list notebook runtimes | source code |
| start notebook runtime | source code |
| stop notebook runtime | source code |
| update notebook runtime template | source code |
| upgrade notebook runtime | source code |
| create persistent resource | source code |
| delete persistent resource | source code |
| get persistent resource | source code |
| list persistent resources | source code |
| reboot persistent resource | source code |
| update persistent resource | source code |
| batch cancel pipeline jobs | source code |
| batch delete pipeline jobs | source code |
| cancel pipeline job | source code |
| cancel training pipeline | source code |
| create pipeline job | source code |
| create training pipeline | source code |
| delete pipeline job | source code |
| delete training pipeline | source code |
| get pipeline job | source code |
| get training pipeline | source code |
| list pipeline jobs | source code |
| list training pipelines | source code |
| direct predict | source code |
| direct raw predict | source code |
| explain | source code |
| generate content | source code |
| predict | source code |
| raw predict | source code |
| server streaming predict | source code |
| stream direct predict | source code |
| stream direct raw predict | source code |
| stream generate content | source code |
| stream raw predict | source code |
| streaming predict | source code |
| streaming raw predict | source code |
| query reasoning engine | source code |
| stream query reasoning engine | source code |
| create reasoning engine | source code |
| delete reasoning engine | source code |
| get reasoning engine | source code |
| list reasoning engines | source code |
| update reasoning engine | source code |
| create schedule | source code |
| delete schedule | source code |
| get schedule | source code |
| list schedules | source code |
| pause schedule | source code |
| resume schedule | source code |
| update schedule | source code |
| cloud | source code |
| create specialist pool | source code |
| delete specialist pool | source code |
| get specialist pool | source code |
| list specialist pools | source code |
| update specialist pool | source code |
| batch create tensorboard runs | source code |
| batch create tensorboard time series | source code |
| batch read tensorboard time series data | source code |
| create tensorboard | source code |
| create tensorboard experiment | source code |
| create tensorboard run | source code |
| create tensorboard time series | source code |
| delete tensorboard | source code |
| delete tensorboard experiment | source code |
| delete tensorboard run | source code |
| delete tensorboard time series | source code |
| export tensorboard time series data | source code |
| get tensorboard | source code |
| get tensorboard experiment | source code |
| get tensorboard run | source code |
| get tensorboard time series | source code |
| list tensorboard experiments | source code |
| list tensorboard runs | source code |
| list tensorboard time series | source code |
| list tensorboards | source code |
| read tensorboard blob data | source code |
| read tensorboard size | source code |
| read tensorboard time series data | source code |
| read tensorboard usage | source code |
| update tensorboard | source code |
| update tensorboard experiment | source code |
| update tensorboard run | source code |
| update tensorboard time series | source code |
| write tensorboard experiment data | source code |
| write tensorboard run data | source code |
| create rag corpus | source code |
| delete rag corpus | source code |
| delete rag file | source code |
| get rag corpus | source code |
| get rag engine config | source code |
| get rag file | source code |
| import rag files | source code |
| list rag corpora | source code |
| list rag files | source code |
| update rag corpus | source code |
| update rag engine config | source code |
| upload rag file | source code |
| augment prompt | source code |
| corroborate content | source code |
| retrieve contexts | source code |
| add trial measurement | source code |
| check trial early stopping state | source code |
| complete trial | source code |
| create study | source code |
| create trial | source code |
| delete study | source code |
| delete trial | source code |
| get study | source code |
| get trial | source code |
| list optimal trials | source code |
| list studies | source code |
| list trials | source code |
| lookup study | source code |
| stop trial | source code |
| suggest trials | source code |
| assemble data | source code |
| assess data | source code |
| create dataset | source code |
| create dataset version | source code |
| delete dataset | source code |
| delete dataset version | source code |
| delete saved query | source code |
| export data | source code |
| get annotation spec | source code |
| get dataset | source code |
| get dataset version | source code |
| import data | source code |
| list annotations | source code |
| list data items | source code |
| list dataset versions | source code |
| list datasets | source code |
| list saved queries | source code |
| restore dataset version | source code |
| search data items | source code |
| update dataset | source code |
| update dataset version | source code |
| create deployment resource pool | source code |
| delete deployment resource pool | source code |
| get deployment resource pool | source code |
| list deployment resource pools | source code |
| query deployed models | source code |
| update deployment resource pool | source code |
| create endpoint | source code |
| delete endpoint | source code |
| deploy model | source code |
| fetch publisher model config | source code |
| get endpoint | source code |
| list endpoints | source code |
| mutate deployed model | source code |
| set publisher model config | source code |
| undeploy model | source code |
| update endpoint | source code |
| update endpoint long running | source code |
| evaluate dataset | source code |
| evaluate instances | source code |
| create example store | source code |
| delete example store | source code |
| fetch examples | source code |
| get example store | source code |
| list example stores | source code |
| remove examples | source code |
| search examples | source code |
| update example store | source code |
| upsert examples | source code |
| execute extension | source code |
| query extension | source code |
| delete extension | source code |
| get extension | source code |
| import extension | source code |
| list extensions | source code |
| update extension | source code |
| create feature online store | source code |
| create feature view | source code |
| delete feature online store | source code |
| delete feature view | source code |
| get feature online store | source code |
| get feature view | source code |
| get feature view sync | source code |
| list feature online stores | source code |
| list feature view syncs | source code |
| list feature views | source code |
| sync feature view | source code |
| update feature online store | source code |
| update feature view | source code |
| feature view direct write | source code |
| fetch feature values | source code |
| generate fetch access token | source code |
| search nearest entities | source code |
| streaming fetch feature values | source code |
| batch create features | source code |
| create feature | source code |
| create feature group | source code |
| create feature monitor | source code |
| create feature monitor job | source code |
| delete feature | source code |
| delete feature group | source code |
| delete feature monitor | source code |
| get feature | source code |
| get feature group | source code |
| get feature monitor | source code |
| get feature monitor job | source code |
| list feature groups | source code |
| list feature monitor jobs | source code |
| list feature monitors | source code |
| list features | source code |
| update feature | source code |
| update feature group | source code |
| update feature monitor | source code |
| read feature values | source code |
| streaming read feature values | source code |
| write feature values | source code |
| batch create features | source code |
| batch read feature values | source code |
| create entity type | source code |
| create feature | source code |
| create featurestore | source code |
| delete entity type | source code |
| delete feature | source code |
| delete feature values | source code |
| delete featurestore | source code |
| export feature values | source code |
| get entity type | source code |
| get feature | source code |
| get featurestore | source code |
| import feature values | source code |
| list entity types | source code |
| list features | source code |
| list featurestores | source code |
| search features | source code |
| update entity type | source code |
| update feature | source code |
| update featurestore | source code |
| create cached content | source code |
| delete cached content | source code |
| get cached content | source code |
| list cached contents | source code |
| update cached content | source code |
| cancel tuning job | source code |
| create tuning job | source code |
| get tuning job | source code |
| list tuning jobs | source code |
| rebase tuned model | source code |
| create index endpoint | source code |
| delete index endpoint | source code |
| deploy index | source code |
| get index endpoint | source code |
| list index endpoints | source code |
| mutate deployed index | source code |
| undeploy index | source code |
| update index endpoint | source code |
| create index | source code |
| delete index | source code |
| get index | source code |
| import index | source code |
| list indexes | source code |
| remove datapoints | source code |
| update index | source code |
| upsert datapoints | source code |
| cancel batch prediction job | source code |
| cancel custom job | source code |
| cancel data labeling job | source code |
| cancel hyperparameter tuning job | source code |
| cancel nas job | source code |
| create batch prediction job | source code |
| create custom job | source code |
| create data labeling job | source code |
| create hyperparameter tuning job | source code |
| create model deployment monitoring job | source code |
| create nas job | source code |
| delete batch prediction job | source code |
| delete custom job | source code |
| delete data labeling job | source code |
| delete hyperparameter tuning job | source code |
| delete model deployment monitoring job | source code |
| delete nas job | source code |
| get batch prediction job | source code |
| get custom job | source code |
| get data labeling job | source code |
| get hyperparameter tuning job | source code |
| get model deployment monitoring job | source code |
| get nas job | source code |
| get nas trial detail | source code |
| list batch prediction jobs | source code |
| list custom jobs | source code |
| list data labeling jobs | source code |
| list hyperparameter tuning jobs | source code |
| list model deployment monitoring jobs | source code |
| list nas jobs | source code |
| list nas trial details | source code |
| pause model deployment monitoring job | source code |
| resume model deployment monitoring job | source code |
| search model deployment monitoring stats anomalies | source code |
| update model deployment monitoring job | source code |
| compute tokens | source code |
| find neighbors | source code |
| read index datapoints | source code |
| create memory | source code |
| delete memory | source code |
| generate memories | source code |
| get memory | source code |
| list memories | source code |
| retrieve memories | source code |
| update memory | source code |
| add context artifacts and executions | source code |
| add context children | source code |
| add execution events | source code |
| create artifact | source code |
| create context | source code |
| create execution | source code |
| create metadata schema | source code |
| create metadata store | source code |
| delete artifact | source code |
| delete context | source code |
| delete execution | source code |
| delete metadata store | source code |
| get artifact | source code |
| get context | source code |
| get execution | source code |
| get metadata schema | source code |
| get metadata store | source code |
| list artifacts | source code |
| list contexts | source code |
| list executions | source code |
| list metadata schemas | source code |
| list metadata stores | source code |
| purge artifacts | source code |
| purge contexts | source code |
| purge executions | source code |
| query artifact lineage subgraph | source code |
| query context lineage subgraph | source code |
| query execution inputs and outputs | source code |
| remove context children | source code |
| update artifact | source code |
| update context | source code |
| update execution | source code |
| batch migrate resources | source code |
| search migratable resources | source code |
| accept publisher model eula | source code |
| check publisher model eula acceptance | source code |
| deploy | source code |
| deploy publisher model | source code |
| export publisher model | source code |
| get publisher model | source code |
| list publisher models | source code |
| create model monitor | source code |
| create model monitoring job | source code |
| delete model monitor | source code |
| delete model monitoring job | source code |
| get model monitor | source code |
| get model monitoring job | source code |
| list model monitoring jobs | source code |
| list model monitors | source code |
| search model monitoring alerts | source code |
| search model monitoring stats | source code |
| update model monitor | source code |
| batch import evaluated annotations | source code |
| batch import model evaluation slices | source code |
| copy model | source code |
| delete model | source code |
| delete model version | source code |
| export model | source code |
| get model | source code |
| get model evaluation | source code |
| get model evaluation slice | source code |
| import model evaluation | source code |
| list model evaluation slices | source code |
| list model evaluations | source code |
| list model version checkpoints | source code |
| list model versions | source code |
| list models | source code |
| merge version aliases | source code |
| recommend spec | source code |
| update explanation dataset | source code |
| update model | source code |
| upload model | source code |
| assign notebook runtime | source code |
| create notebook execution job | source code |
| create notebook runtime template | source code |
| delete notebook execution job | source code |
| delete notebook runtime | source code |
| delete notebook runtime template | source code |
| get notebook execution job | source code |
| get notebook runtime | source code |
| get notebook runtime template | source code |
| list notebook execution jobs | source code |
| list notebook runtime templates | source code |
| list notebook runtimes | source code |
| start notebook runtime | source code |
| stop notebook runtime | source code |
| update notebook runtime template | source code |
| upgrade notebook runtime | source code |
| create persistent resource | source code |
| delete persistent resource | source code |
| get persistent resource | source code |
| list persistent resources | source code |
| reboot persistent resource | source code |
| update persistent resource | source code |
| batch cancel pipeline jobs | source code |
| batch delete pipeline jobs | source code |
| cancel pipeline job | source code |
| cancel training pipeline | source code |
| create pipeline job | source code |
| create training pipeline | source code |
| delete pipeline job | source code |
| delete training pipeline | source code |
| get pipeline job | source code |
| get training pipeline | source code |
| list pipeline jobs | source code |
| list training pipelines | source code |
| chat completions | source code |
| count tokens | source code |
| direct predict | source code |
| direct raw predict | source code |
| explain | source code |
| generate content | source code |
| predict | source code |
| raw predict | source code |
| server streaming predict | source code |
| stream direct predict | source code |
| stream direct raw predict | source code |
| stream generate content | source code |
| stream raw predict | source code |
| streaming predict | source code |
| streaming raw predict | source code |
| query reasoning engine | source code |
| stream query reasoning engine | source code |
| create reasoning engine | source code |
| delete reasoning engine | source code |
| get reasoning engine | source code |
| list reasoning engines | source code |
| update reasoning engine | source code |
| create schedule | source code |
| delete schedule | source code |
| get schedule | source code |
| list schedules | source code |
| pause schedule | source code |
| resume schedule | source code |
| update schedule | source code |
| append event | source code |
| create session | source code |
| delete session | source code |
| get session | source code |
| list events | source code |
| list sessions | source code |
| update session | source code |
| cloud | source code |
| create specialist pool | source code |
| delete specialist pool | source code |
| get specialist pool | source code |
| list specialist pools | source code |
| update specialist pool | source code |
| batch create tensorboard runs | source code |
| batch create tensorboard time series | source code |
| batch read tensorboard time series data | source code |
| create tensorboard | source code |
| create tensorboard experiment | source code |
| create tensorboard run | source code |
| create tensorboard time series | source code |
| delete tensorboard | source code |
| delete tensorboard experiment | source code |
| delete tensorboard run | source code |
| delete tensorboard time series | source code |
| export tensorboard time series data | source code |
| get tensorboard | source code |
| get tensorboard experiment | source code |
| get tensorboard run | source code |
| get tensorboard time series | source code |
| list tensorboard experiments | source code |
| list tensorboard runs | source code |
| list tensorboard time series | source code |
| list tensorboards | source code |
| read tensorboard blob data | source code |
| read tensorboard size | source code |
| read tensorboard time series data | source code |
| read tensorboard usage | source code |
| update tensorboard | source code |
| update tensorboard experiment | source code |
| update tensorboard run | source code |
| update tensorboard time series | source code |
| write tensorboard experiment data | source code |
| write tensorboard run data | source code |
| create rag corpus | source code |
| delete rag corpus | source code |
| delete rag file | source code |
| get rag corpus | source code |
| get rag engine config | source code |
| get rag file | source code |
| import rag files | source code |
| list rag corpora | source code |
| list rag files | source code |
| update rag corpus | source code |
| update rag engine config | source code |
| upload rag file | source code |
| augment prompt | source code |
| corroborate content | source code |
| retrieve contexts | source code |
| add trial measurement | source code |
| check trial early stopping state | source code |
| complete trial | source code |
| create study | source code |
| create trial | source code |
| delete study | source code |
| delete trial | source code |
| get study | source code |
| get trial | source code |
| list optimal trials | source code |
| list studies | source code |
| list trials | source code |
| lookup study | source code |
| stop trial | source code |
| suggest trials | source code |
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.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
License
Apache Version 2.0
See LICENSE