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

Vertex AI: Node.js Client

release level npm version

Vertex AI client for Node.js

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

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
// const location = 'YOUR_PROJECT_LOCATION';

const {EndpointServiceClient} = require('@google-cloud/aiplatform');

// Specifies the location of the api endpoint
const clientOptions = {
  apiEndpoint: 'us-central1-aiplatform.googleapis.com',
};
const client = new EndpointServiceClient(clientOptions);

async function listEndpoints() {
  // Configure the parent resource
  const parent = `projects/${projectId}/locations/${location}`;
  const request = {
    parent,
  };

  // Get and print out a list of all the endpoints for this resource
  const [result] = await client.listEndpoints(request);
  for (const endpoint of result) {
    console.log(`\nEndpoint name: ${endpoint.name}`);
    console.log(`Display name: ${endpoint.displayName}`);
    if (endpoint.deployedModels[0]) {
      console.log(
        `First deployed model: ${endpoint.deployedModels[0].model}`
      );
    }
  }
}
listEndpoints();

Samples

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

SampleSource CodeTry it
Dataset_service.create_datasetsource codeOpen in Cloud Shell
Dataset_service.delete_datasetsource codeOpen in Cloud Shell
Dataset_service.export_datasource codeOpen in Cloud Shell
Dataset_service.get_annotation_specsource codeOpen in Cloud Shell
Dataset_service.get_datasetsource codeOpen in Cloud Shell
Dataset_service.import_datasource codeOpen in Cloud Shell
Dataset_service.list_annotationssource codeOpen in Cloud Shell
Dataset_service.list_data_itemssource codeOpen in Cloud Shell
Dataset_service.list_datasetssource codeOpen in Cloud Shell
Dataset_service.list_saved_queriessource codeOpen in Cloud Shell
Dataset_service.search_data_itemssource codeOpen in Cloud Shell
Dataset_service.update_datasetsource codeOpen in Cloud Shell
Endpoint_service.create_endpointsource codeOpen in Cloud Shell
Endpoint_service.delete_endpointsource codeOpen in Cloud Shell
Endpoint_service.deploy_modelsource codeOpen in Cloud Shell
Endpoint_service.get_endpointsource codeOpen in Cloud Shell
Endpoint_service.list_endpointssource codeOpen in Cloud Shell
Endpoint_service.undeploy_modelsource codeOpen in Cloud Shell
Endpoint_service.update_endpointsource codeOpen in Cloud Shell
Featurestore_online_serving_service.read_feature_valuessource codeOpen in Cloud Shell
Featurestore_online_serving_service.streaming_read_feature_valuessource codeOpen in Cloud Shell
Featurestore_online_serving_service.write_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.batch_create_featuressource codeOpen in Cloud Shell
Featurestore_service.batch_read_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.create_entity_typesource codeOpen in Cloud Shell
Featurestore_service.create_featuresource codeOpen in Cloud Shell
Featurestore_service.create_featurestoresource codeOpen in Cloud Shell
Featurestore_service.delete_entity_typesource codeOpen in Cloud Shell
Featurestore_service.delete_featuresource codeOpen in Cloud Shell
Featurestore_service.delete_featurestoresource codeOpen in Cloud Shell
Featurestore_service.export_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.get_entity_typesource codeOpen in Cloud Shell
Featurestore_service.get_featuresource codeOpen in Cloud Shell
Featurestore_service.get_featurestoresource codeOpen in Cloud Shell
Featurestore_service.import_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.list_entity_typessource codeOpen in Cloud Shell
Featurestore_service.list_featuressource codeOpen in Cloud Shell
Featurestore_service.list_featurestoressource codeOpen in Cloud Shell
Featurestore_service.search_featuressource codeOpen in Cloud Shell
Featurestore_service.update_entity_typesource codeOpen in Cloud Shell
Featurestore_service.update_featuresource codeOpen in Cloud Shell
Featurestore_service.update_featurestoresource codeOpen in Cloud Shell
Index_endpoint_service.create_index_endpointsource codeOpen in Cloud Shell
Index_endpoint_service.delete_index_endpointsource codeOpen in Cloud Shell
Index_endpoint_service.deploy_indexsource codeOpen in Cloud Shell
Index_endpoint_service.get_index_endpointsource codeOpen in Cloud Shell
Index_endpoint_service.list_index_endpointssource codeOpen in Cloud Shell
Index_endpoint_service.mutate_deployed_indexsource codeOpen in Cloud Shell
Index_endpoint_service.undeploy_indexsource codeOpen in Cloud Shell
Index_endpoint_service.update_index_endpointsource codeOpen in Cloud Shell
Index_service.create_indexsource codeOpen in Cloud Shell
Index_service.delete_indexsource codeOpen in Cloud Shell
Index_service.get_indexsource codeOpen in Cloud Shell
Index_service.list_indexessource codeOpen in Cloud Shell
Index_service.remove_datapointssource codeOpen in Cloud Shell
Index_service.update_indexsource codeOpen in Cloud Shell
Index_service.upsert_datapointssource codeOpen in Cloud Shell
Job_service.cancel_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.cancel_custom_jobsource codeOpen in Cloud Shell
Job_service.cancel_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.cancel_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.create_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.create_custom_jobsource codeOpen in Cloud Shell
Job_service.create_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.create_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.create_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.delete_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.delete_custom_jobsource codeOpen in Cloud Shell
Job_service.delete_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.delete_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.delete_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.get_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.get_custom_jobsource codeOpen in Cloud Shell
Job_service.get_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.get_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.get_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.list_batch_prediction_jobssource codeOpen in Cloud Shell
Job_service.list_custom_jobssource codeOpen in Cloud Shell
Job_service.list_data_labeling_jobssource codeOpen in Cloud Shell
Job_service.list_hyperparameter_tuning_jobssource codeOpen in Cloud Shell
Job_service.list_model_deployment_monitoring_jobssource codeOpen in Cloud Shell
Job_service.pause_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.resume_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.search_model_deployment_monitoring_stats_anomaliessource codeOpen in Cloud Shell
Job_service.update_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Metadata_service.add_context_artifacts_and_executionssource codeOpen in Cloud Shell
Metadata_service.add_context_childrensource codeOpen in Cloud Shell
Metadata_service.add_execution_eventssource codeOpen in Cloud Shell
Metadata_service.create_artifactsource codeOpen in Cloud Shell
Metadata_service.create_contextsource codeOpen in Cloud Shell
Metadata_service.create_executionsource codeOpen in Cloud Shell
Metadata_service.create_metadata_schemasource codeOpen in Cloud Shell
Metadata_service.create_metadata_storesource codeOpen in Cloud Shell
Metadata_service.delete_artifactsource codeOpen in Cloud Shell
Metadata_service.delete_contextsource codeOpen in Cloud Shell
Metadata_service.delete_executionsource codeOpen in Cloud Shell
Metadata_service.delete_metadata_storesource codeOpen in Cloud Shell
Metadata_service.get_artifactsource codeOpen in Cloud Shell
Metadata_service.get_contextsource codeOpen in Cloud Shell
Metadata_service.get_executionsource codeOpen in Cloud Shell
Metadata_service.get_metadata_schemasource codeOpen in Cloud Shell
Metadata_service.get_metadata_storesource codeOpen in Cloud Shell
Metadata_service.list_artifactssource codeOpen in Cloud Shell
Metadata_service.list_contextssource codeOpen in Cloud Shell
Metadata_service.list_executionssource codeOpen in Cloud Shell
Metadata_service.list_metadata_schemassource codeOpen in Cloud Shell
Metadata_service.list_metadata_storessource codeOpen in Cloud Shell
Metadata_service.purge_artifactssource codeOpen in Cloud Shell
Metadata_service.purge_contextssource codeOpen in Cloud Shell
Metadata_service.purge_executionssource codeOpen in Cloud Shell
Metadata_service.query_artifact_lineage_subgraphsource codeOpen in Cloud Shell
Metadata_service.query_context_lineage_subgraphsource codeOpen in Cloud Shell
Metadata_service.query_execution_inputs_and_outputssource codeOpen in Cloud Shell
Metadata_service.remove_context_childrensource codeOpen in Cloud Shell
Metadata_service.update_artifactsource codeOpen in Cloud Shell
Metadata_service.update_contextsource codeOpen in Cloud Shell
Metadata_service.update_executionsource codeOpen in Cloud Shell
Migration_service.batch_migrate_resourcessource codeOpen in Cloud Shell
Migration_service.search_migratable_resourcessource codeOpen in Cloud Shell
Model_service.batch_import_model_evaluation_slicessource codeOpen in Cloud Shell
Model_service.delete_modelsource codeOpen in Cloud Shell
Model_service.delete_model_versionsource codeOpen in Cloud Shell
Model_service.export_modelsource codeOpen in Cloud Shell
Model_service.get_modelsource codeOpen in Cloud Shell
Model_service.get_model_evaluationsource codeOpen in Cloud Shell
Model_service.get_model_evaluation_slicesource codeOpen in Cloud Shell
Model_service.import_model_evaluationsource codeOpen in Cloud Shell
Model_service.list_model_evaluation_slicessource codeOpen in Cloud Shell
Model_service.list_model_evaluationssource codeOpen in Cloud Shell
Model_service.list_model_versionssource codeOpen in Cloud Shell
Model_service.list_modelssource codeOpen in Cloud Shell
Model_service.merge_version_aliasessource codeOpen in Cloud Shell
Model_service.update_modelsource codeOpen in Cloud Shell
Model_service.upload_modelsource codeOpen in Cloud Shell
Pipeline_service.cancel_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.cancel_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.create_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.create_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.delete_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.delete_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.get_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.get_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.list_pipeline_jobssource codeOpen in Cloud Shell
Pipeline_service.list_training_pipelinessource codeOpen in Cloud Shell
Prediction_service.explainsource codeOpen in Cloud Shell
Prediction_service.predictsource codeOpen in Cloud Shell
Prediction_service.raw_predictsource codeOpen in Cloud Shell
Specialist_pool_service.create_specialist_poolsource codeOpen in Cloud Shell
Specialist_pool_service.delete_specialist_poolsource codeOpen in Cloud Shell
Specialist_pool_service.get_specialist_poolsource codeOpen in Cloud Shell
Specialist_pool_service.list_specialist_poolssource codeOpen in Cloud Shell
Specialist_pool_service.update_specialist_poolsource codeOpen in Cloud Shell
Tensorboard_service.batch_create_tensorboard_runssource codeOpen in Cloud Shell
Tensorboard_service.batch_create_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.batch_read_tensorboard_time_series_datasource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.export_tensorboard_time_series_datasource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboard_experimentssource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboard_runssource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboardssource codeOpen in Cloud Shell
Tensorboard_service.read_tensorboard_blob_datasource codeOpen in Cloud Shell
Tensorboard_service.read_tensorboard_time_series_datasource codeOpen in Cloud Shell
Tensorboard_service.read_tensorboard_usagesource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.write_tensorboard_experiment_datasource codeOpen in Cloud Shell
Tensorboard_service.write_tensorboard_run_datasource codeOpen in Cloud Shell
Vizier_service.add_trial_measurementsource codeOpen in Cloud Shell
Vizier_service.check_trial_early_stopping_statesource codeOpen in Cloud Shell
Vizier_service.complete_trialsource codeOpen in Cloud Shell
Vizier_service.create_studysource codeOpen in Cloud Shell
Vizier_service.create_trialsource codeOpen in Cloud Shell
Vizier_service.delete_studysource codeOpen in Cloud Shell
Vizier_service.delete_trialsource codeOpen in Cloud Shell
Vizier_service.get_studysource codeOpen in Cloud Shell
Vizier_service.get_trialsource codeOpen in Cloud Shell
Vizier_service.list_optimal_trialssource codeOpen in Cloud Shell
Vizier_service.list_studiessource codeOpen in Cloud Shell
Vizier_service.list_trialssource codeOpen in Cloud Shell
Vizier_service.lookup_studysource codeOpen in Cloud Shell
Vizier_service.stop_trialsource codeOpen in Cloud Shell
Vizier_service.suggest_trialssource codeOpen in Cloud Shell
Dataset_service.create_datasetsource codeOpen in Cloud Shell
Dataset_service.delete_datasetsource codeOpen in Cloud Shell
Dataset_service.export_datasource codeOpen in Cloud Shell
Dataset_service.get_annotation_specsource codeOpen in Cloud Shell
Dataset_service.get_datasetsource codeOpen in Cloud Shell
Dataset_service.import_datasource codeOpen in Cloud Shell
Dataset_service.list_annotationssource codeOpen in Cloud Shell
Dataset_service.list_data_itemssource codeOpen in Cloud Shell
Dataset_service.list_datasetssource codeOpen in Cloud Shell
Dataset_service.list_saved_queriessource codeOpen in Cloud Shell
Dataset_service.search_data_itemssource codeOpen in Cloud Shell
Dataset_service.update_datasetsource codeOpen in Cloud Shell
Deployment_resource_pool_service.create_deployment_resource_poolsource codeOpen in Cloud Shell
Deployment_resource_pool_service.delete_deployment_resource_poolsource codeOpen in Cloud Shell
Deployment_resource_pool_service.get_deployment_resource_poolsource codeOpen in Cloud Shell
Deployment_resource_pool_service.list_deployment_resource_poolssource codeOpen in Cloud Shell
Deployment_resource_pool_service.query_deployed_modelssource codeOpen in Cloud Shell
Endpoint_service.create_endpointsource codeOpen in Cloud Shell
Endpoint_service.delete_endpointsource codeOpen in Cloud Shell
Endpoint_service.deploy_modelsource codeOpen in Cloud Shell
Endpoint_service.get_endpointsource codeOpen in Cloud Shell
Endpoint_service.list_endpointssource codeOpen in Cloud Shell
Endpoint_service.undeploy_modelsource codeOpen in Cloud Shell
Endpoint_service.update_endpointsource codeOpen in Cloud Shell
Featurestore_online_serving_service.read_feature_valuessource codeOpen in Cloud Shell
Featurestore_online_serving_service.streaming_read_feature_valuessource codeOpen in Cloud Shell
Featurestore_online_serving_service.write_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.batch_create_featuressource codeOpen in Cloud Shell
Featurestore_service.batch_read_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.create_entity_typesource codeOpen in Cloud Shell
Featurestore_service.create_featuresource codeOpen in Cloud Shell
Featurestore_service.create_featurestoresource codeOpen in Cloud Shell
Featurestore_service.delete_entity_typesource codeOpen in Cloud Shell
Featurestore_service.delete_featuresource codeOpen in Cloud Shell
Featurestore_service.delete_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.delete_featurestoresource codeOpen in Cloud Shell
Featurestore_service.export_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.get_entity_typesource codeOpen in Cloud Shell
Featurestore_service.get_featuresource codeOpen in Cloud Shell
Featurestore_service.get_featurestoresource codeOpen in Cloud Shell
Featurestore_service.import_feature_valuessource codeOpen in Cloud Shell
Featurestore_service.list_entity_typessource codeOpen in Cloud Shell
Featurestore_service.list_featuressource codeOpen in Cloud Shell
Featurestore_service.list_featurestoressource codeOpen in Cloud Shell
Featurestore_service.search_featuressource codeOpen in Cloud Shell
Featurestore_service.update_entity_typesource codeOpen in Cloud Shell
Featurestore_service.update_featuresource codeOpen in Cloud Shell
Featurestore_service.update_featurestoresource codeOpen in Cloud Shell
Index_endpoint_service.create_index_endpointsource codeOpen in Cloud Shell
Index_endpoint_service.delete_index_endpointsource codeOpen in Cloud Shell
Index_endpoint_service.deploy_indexsource codeOpen in Cloud Shell
Index_endpoint_service.get_index_endpointsource codeOpen in Cloud Shell
Index_endpoint_service.list_index_endpointssource codeOpen in Cloud Shell
Index_endpoint_service.mutate_deployed_indexsource codeOpen in Cloud Shell
Index_endpoint_service.undeploy_indexsource codeOpen in Cloud Shell
Index_endpoint_service.update_index_endpointsource codeOpen in Cloud Shell
Index_service.create_indexsource codeOpen in Cloud Shell
Index_service.delete_indexsource codeOpen in Cloud Shell
Index_service.get_indexsource codeOpen in Cloud Shell
Index_service.list_indexessource codeOpen in Cloud Shell
Index_service.remove_datapointssource codeOpen in Cloud Shell
Index_service.update_indexsource codeOpen in Cloud Shell
Index_service.upsert_datapointssource codeOpen in Cloud Shell
Job_service.cancel_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.cancel_custom_jobsource codeOpen in Cloud Shell
Job_service.cancel_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.cancel_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.create_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.create_custom_jobsource codeOpen in Cloud Shell
Job_service.create_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.create_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.create_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.delete_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.delete_custom_jobsource codeOpen in Cloud Shell
Job_service.delete_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.delete_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.delete_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.get_batch_prediction_jobsource codeOpen in Cloud Shell
Job_service.get_custom_jobsource codeOpen in Cloud Shell
Job_service.get_data_labeling_jobsource codeOpen in Cloud Shell
Job_service.get_hyperparameter_tuning_jobsource codeOpen in Cloud Shell
Job_service.get_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.list_batch_prediction_jobssource codeOpen in Cloud Shell
Job_service.list_custom_jobssource codeOpen in Cloud Shell
Job_service.list_data_labeling_jobssource codeOpen in Cloud Shell
Job_service.list_hyperparameter_tuning_jobssource codeOpen in Cloud Shell
Job_service.list_model_deployment_monitoring_jobssource codeOpen in Cloud Shell
Job_service.pause_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.resume_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Job_service.search_model_deployment_monitoring_stats_anomaliessource codeOpen in Cloud Shell
Job_service.update_model_deployment_monitoring_jobsource codeOpen in Cloud Shell
Metadata_service.add_context_artifacts_and_executionssource codeOpen in Cloud Shell
Metadata_service.add_context_childrensource codeOpen in Cloud Shell
Metadata_service.add_execution_eventssource codeOpen in Cloud Shell
Metadata_service.create_artifactsource codeOpen in Cloud Shell
Metadata_service.create_contextsource codeOpen in Cloud Shell
Metadata_service.create_executionsource codeOpen in Cloud Shell
Metadata_service.create_metadata_schemasource codeOpen in Cloud Shell
Metadata_service.create_metadata_storesource codeOpen in Cloud Shell
Metadata_service.delete_artifactsource codeOpen in Cloud Shell
Metadata_service.delete_contextsource codeOpen in Cloud Shell
Metadata_service.delete_executionsource codeOpen in Cloud Shell
Metadata_service.delete_metadata_storesource codeOpen in Cloud Shell
Metadata_service.get_artifactsource codeOpen in Cloud Shell
Metadata_service.get_contextsource codeOpen in Cloud Shell
Metadata_service.get_executionsource codeOpen in Cloud Shell
Metadata_service.get_metadata_schemasource codeOpen in Cloud Shell
Metadata_service.get_metadata_storesource codeOpen in Cloud Shell
Metadata_service.list_artifactssource codeOpen in Cloud Shell
Metadata_service.list_contextssource codeOpen in Cloud Shell
Metadata_service.list_executionssource codeOpen in Cloud Shell
Metadata_service.list_metadata_schemassource codeOpen in Cloud Shell
Metadata_service.list_metadata_storessource codeOpen in Cloud Shell
Metadata_service.purge_artifactssource codeOpen in Cloud Shell
Metadata_service.purge_contextssource codeOpen in Cloud Shell
Metadata_service.purge_executionssource codeOpen in Cloud Shell
Metadata_service.query_artifact_lineage_subgraphsource codeOpen in Cloud Shell
Metadata_service.query_context_lineage_subgraphsource codeOpen in Cloud Shell
Metadata_service.query_execution_inputs_and_outputssource codeOpen in Cloud Shell
Metadata_service.remove_context_childrensource codeOpen in Cloud Shell
Metadata_service.update_artifactsource codeOpen in Cloud Shell
Metadata_service.update_contextsource codeOpen in Cloud Shell
Metadata_service.update_executionsource codeOpen in Cloud Shell
Migration_service.batch_migrate_resourcessource codeOpen in Cloud Shell
Migration_service.search_migratable_resourcessource codeOpen in Cloud Shell
Model_service.batch_import_model_evaluation_slicessource codeOpen in Cloud Shell
Model_service.delete_modelsource codeOpen in Cloud Shell
Model_service.delete_model_versionsource codeOpen in Cloud Shell
Model_service.export_modelsource codeOpen in Cloud Shell
Model_service.get_modelsource codeOpen in Cloud Shell
Model_service.get_model_evaluationsource codeOpen in Cloud Shell
Model_service.get_model_evaluation_slicesource codeOpen in Cloud Shell
Model_service.import_model_evaluationsource codeOpen in Cloud Shell
Model_service.list_model_evaluation_slicessource codeOpen in Cloud Shell
Model_service.list_model_evaluationssource codeOpen in Cloud Shell
Model_service.list_model_versionssource codeOpen in Cloud Shell
Model_service.list_modelssource codeOpen in Cloud Shell
Model_service.merge_version_aliasessource codeOpen in Cloud Shell
Model_service.update_explanation_datasetsource codeOpen in Cloud Shell
Model_service.update_modelsource codeOpen in Cloud Shell
Model_service.upload_modelsource codeOpen in Cloud Shell
Pipeline_service.cancel_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.cancel_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.create_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.create_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.delete_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.delete_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.get_pipeline_jobsource codeOpen in Cloud Shell
Pipeline_service.get_training_pipelinesource codeOpen in Cloud Shell
Pipeline_service.list_pipeline_jobssource codeOpen in Cloud Shell
Pipeline_service.list_training_pipelinessource codeOpen in Cloud Shell
Prediction_service.explainsource codeOpen in Cloud Shell
Prediction_service.predictsource codeOpen in Cloud Shell
Prediction_service.raw_predictsource codeOpen in Cloud Shell
Specialist_pool_service.create_specialist_poolsource codeOpen in Cloud Shell
Specialist_pool_service.delete_specialist_poolsource codeOpen in Cloud Shell
Specialist_pool_service.get_specialist_poolsource codeOpen in Cloud Shell
Specialist_pool_service.list_specialist_poolssource codeOpen in Cloud Shell
Specialist_pool_service.update_specialist_poolsource codeOpen in Cloud Shell
Tensorboard_service.batch_create_tensorboard_runssource codeOpen in Cloud Shell
Tensorboard_service.batch_create_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.batch_read_tensorboard_time_series_datasource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.create_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.delete_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.export_tensorboard_time_series_datasource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.get_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboard_experimentssource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboard_runssource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.list_tensorboardssource codeOpen in Cloud Shell
Tensorboard_service.read_tensorboard_blob_datasource codeOpen in Cloud Shell
Tensorboard_service.read_tensorboard_time_series_datasource codeOpen in Cloud Shell
Tensorboard_service.read_tensorboard_usagesource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboardsource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboard_experimentsource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboard_runsource codeOpen in Cloud Shell
Tensorboard_service.update_tensorboard_time_seriessource codeOpen in Cloud Shell
Tensorboard_service.write_tensorboard_experiment_datasource codeOpen in Cloud Shell
Tensorboard_service.write_tensorboard_run_datasource codeOpen in Cloud Shell
Vizier_service.add_trial_measurementsource codeOpen in Cloud Shell
Vizier_service.check_trial_early_stopping_statesource codeOpen in Cloud Shell
Vizier_service.complete_trialsource codeOpen in Cloud Shell
Vizier_service.create_studysource codeOpen in Cloud Shell
Vizier_service.create_trialsource codeOpen in Cloud Shell
Vizier_service.delete_studysource codeOpen in Cloud Shell
Vizier_service.delete_trialsource codeOpen in Cloud Shell
Vizier_service.get_studysource codeOpen in Cloud Shell
Vizier_service.get_trialsource codeOpen in Cloud Shell
Vizier_service.list_optimal_trialssource codeOpen in Cloud Shell
Vizier_service.list_studiessource codeOpen in Cloud Shell
Vizier_service.list_trialssource codeOpen in Cloud Shell
Vizier_service.lookup_studysource codeOpen in Cloud Shell
Vizier_service.stop_trialsource codeOpen in Cloud Shell
Vizier_service.suggest_trialssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstart.testsource 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