@google-cloud/aiplatform

Vertex AI: Node.js Client

Vertex AI client for Node.js

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

• Vertex AI Node.js Client API Reference
• Vertex AI Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-aiplatform

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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 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.

Sample	Source Code	Try it
Dataset_service.create_dataset	source code
Dataset_service.create_dataset_version	source code
Dataset_service.delete_dataset	source code
Dataset_service.delete_dataset_version	source code
Dataset_service.delete_saved_query	source code
Dataset_service.export_data	source code
Dataset_service.get_annotation_spec	source code
Dataset_service.get_dataset	source code
Dataset_service.get_dataset_version	source code
Dataset_service.import_data	source code
Dataset_service.list_annotations	source code
Dataset_service.list_data_items	source code
Dataset_service.list_dataset_versions	source code
Dataset_service.list_datasets	source code
Dataset_service.list_saved_queries	source code
Dataset_service.restore_dataset_version	source code
Dataset_service.search_data_items	source code
Dataset_service.update_dataset	source code
Dataset_service.update_dataset_version	source code
Deployment_resource_pool_service.create_deployment_resource_pool	source code
Deployment_resource_pool_service.delete_deployment_resource_pool	source code
Deployment_resource_pool_service.get_deployment_resource_pool	source code
Deployment_resource_pool_service.list_deployment_resource_pools	source code
Deployment_resource_pool_service.query_deployed_models	source code
Deployment_resource_pool_service.update_deployment_resource_pool	source code
Endpoint_service.create_endpoint	source code
Endpoint_service.delete_endpoint	source code
Endpoint_service.deploy_model	source code
Endpoint_service.get_endpoint	source code
Endpoint_service.list_endpoints	source code
Endpoint_service.mutate_deployed_model	source code
Endpoint_service.undeploy_model	source code
Endpoint_service.update_endpoint	source code
Evaluation_service.evaluate_instances	source code
Feature_online_store_admin_service.create_feature_online_store	source code
Feature_online_store_admin_service.create_feature_view	source code
Feature_online_store_admin_service.delete_feature_online_store	source code
Feature_online_store_admin_service.delete_feature_view	source code
Feature_online_store_admin_service.get_feature_online_store	source code
Feature_online_store_admin_service.get_feature_view	source code
Feature_online_store_admin_service.get_feature_view_sync	source code
Feature_online_store_admin_service.list_feature_online_stores	source code
Feature_online_store_admin_service.list_feature_view_syncs	source code
Feature_online_store_admin_service.list_feature_views	source code
Feature_online_store_admin_service.sync_feature_view	source code
Feature_online_store_admin_service.update_feature_online_store	source code
Feature_online_store_admin_service.update_feature_view	source code
Feature_online_store_service.fetch_feature_values	source code
Feature_online_store_service.search_nearest_entities	source code
Feature_registry_service.batch_create_features	source code
Feature_registry_service.create_feature	source code
Feature_registry_service.create_feature_group	source code
Feature_registry_service.delete_feature	source code
Feature_registry_service.delete_feature_group	source code
Feature_registry_service.get_feature	source code
Feature_registry_service.get_feature_group	source code
Feature_registry_service.list_feature_groups	source code
Feature_registry_service.list_features	source code
Feature_registry_service.update_feature	source code
Feature_registry_service.update_feature_group	source code
Featurestore_online_serving_service.read_feature_values	source code
Featurestore_online_serving_service.streaming_read_feature_values	source code
Featurestore_online_serving_service.write_feature_values	source code
Featurestore_service.batch_create_features	source code
Featurestore_service.batch_read_feature_values	source code
Featurestore_service.create_entity_type	source code
Featurestore_service.create_feature	source code
Featurestore_service.create_featurestore	source code
Featurestore_service.delete_entity_type	source code
Featurestore_service.delete_feature	source code
Featurestore_service.delete_feature_values	source code
Featurestore_service.delete_featurestore	source code
Featurestore_service.export_feature_values	source code
Featurestore_service.get_entity_type	source code
Featurestore_service.get_feature	source code
Featurestore_service.get_featurestore	source code
Featurestore_service.import_feature_values	source code
Featurestore_service.list_entity_types	source code
Featurestore_service.list_features	source code
Featurestore_service.list_featurestores	source code
Featurestore_service.search_features	source code
Featurestore_service.update_entity_type	source code
Featurestore_service.update_feature	source code
Featurestore_service.update_featurestore	source code
Gen_ai_tuning_service.cancel_tuning_job	source code
Gen_ai_tuning_service.create_tuning_job	source code
Gen_ai_tuning_service.get_tuning_job	source code
Gen_ai_tuning_service.list_tuning_jobs	source code
Gen_ai_tuning_service.rebase_tuned_model	source code
Index_endpoint_service.create_index_endpoint	source code
Index_endpoint_service.delete_index_endpoint	source code
Index_endpoint_service.deploy_index	source code
Index_endpoint_service.get_index_endpoint	source code
Index_endpoint_service.list_index_endpoints	source code
Index_endpoint_service.mutate_deployed_index	source code
Index_endpoint_service.undeploy_index	source code
Index_endpoint_service.update_index_endpoint	source code
Index_service.create_index	source code
Index_service.delete_index	source code
Index_service.get_index	source code
Index_service.list_indexes	source code
Index_service.remove_datapoints	source code
Index_service.update_index	source code
Index_service.upsert_datapoints	source code
Job_service.cancel_batch_prediction_job	source code
Job_service.cancel_custom_job	source code
Job_service.cancel_data_labeling_job	source code
Job_service.cancel_hyperparameter_tuning_job	source code
Job_service.cancel_nas_job	source code
Job_service.create_batch_prediction_job	source code
Job_service.create_custom_job	source code
Job_service.create_data_labeling_job	source code
Job_service.create_hyperparameter_tuning_job	source code
Job_service.create_model_deployment_monitoring_job	source code
Job_service.create_nas_job	source code
Job_service.delete_batch_prediction_job	source code
Job_service.delete_custom_job	source code
Job_service.delete_data_labeling_job	source code
Job_service.delete_hyperparameter_tuning_job	source code
Job_service.delete_model_deployment_monitoring_job	source code
Job_service.delete_nas_job	source code
Job_service.get_batch_prediction_job	source code
Job_service.get_custom_job	source code
Job_service.get_data_labeling_job	source code
Job_service.get_hyperparameter_tuning_job	source code
Job_service.get_model_deployment_monitoring_job	source code
Job_service.get_nas_job	source code
Job_service.get_nas_trial_detail	source code
Job_service.list_batch_prediction_jobs	source code
Job_service.list_custom_jobs	source code
Job_service.list_data_labeling_jobs	source code
Job_service.list_hyperparameter_tuning_jobs	source code
Job_service.list_model_deployment_monitoring_jobs	source code
Job_service.list_nas_jobs	source code
Job_service.list_nas_trial_details	source code
Job_service.pause_model_deployment_monitoring_job	source code
Job_service.resume_model_deployment_monitoring_job	source code
Job_service.search_model_deployment_monitoring_stats_anomalies	source code
Job_service.update_model_deployment_monitoring_job	source code
Llm_utility_service.compute_tokens	source code
Llm_utility_service.count_tokens	source code
Match_service.find_neighbors	source code
Match_service.read_index_datapoints	source code
Metadata_service.add_context_artifacts_and_executions	source code
Metadata_service.add_context_children	source code
Metadata_service.add_execution_events	source code
Metadata_service.create_artifact	source code
Metadata_service.create_context	source code
Metadata_service.create_execution	source code
Metadata_service.create_metadata_schema	source code
Metadata_service.create_metadata_store	source code
Metadata_service.delete_artifact	source code
Metadata_service.delete_context	source code
Metadata_service.delete_execution	source code
Metadata_service.delete_metadata_store	source code
Metadata_service.get_artifact	source code
Metadata_service.get_context	source code
Metadata_service.get_execution	source code
Metadata_service.get_metadata_schema	source code
Metadata_service.get_metadata_store	source code
Metadata_service.list_artifacts	source code
Metadata_service.list_contexts	source code
Metadata_service.list_executions	source code
Metadata_service.list_metadata_schemas	source code
Metadata_service.list_metadata_stores	source code
Metadata_service.purge_artifacts	source code
Metadata_service.purge_contexts	source code
Metadata_service.purge_executions	source code
Metadata_service.query_artifact_lineage_subgraph	source code
Metadata_service.query_context_lineage_subgraph	source code
Metadata_service.query_execution_inputs_and_outputs	source code
Metadata_service.remove_context_children	source code
Metadata_service.update_artifact	source code
Metadata_service.update_context	source code
Metadata_service.update_execution	source code
Migration_service.batch_migrate_resources	source code
Migration_service.search_migratable_resources	source code
Model_garden_service.get_publisher_model	source code
Model_service.batch_import_evaluated_annotations	source code
Model_service.batch_import_model_evaluation_slices	source code
Model_service.copy_model	source code
Model_service.delete_model	source code
Model_service.delete_model_version	source code
Model_service.export_model	source code
Model_service.get_model	source code
Model_service.get_model_evaluation	source code
Model_service.get_model_evaluation_slice	source code
Model_service.import_model_evaluation	source code
Model_service.list_model_evaluation_slices	source code
Model_service.list_model_evaluations	source code
Model_service.list_model_versions	source code
Model_service.list_models	source code
Model_service.merge_version_aliases	source code
Model_service.update_explanation_dataset	source code
Model_service.update_model	source code
Model_service.upload_model	source code
Notebook_service.assign_notebook_runtime	source code
Notebook_service.create_notebook_execution_job	source code
Notebook_service.create_notebook_runtime_template	source code
Notebook_service.delete_notebook_execution_job	source code
Notebook_service.delete_notebook_runtime	source code
Notebook_service.delete_notebook_runtime_template	source code
Notebook_service.get_notebook_execution_job	source code
Notebook_service.get_notebook_runtime	source code
Notebook_service.get_notebook_runtime_template	source code
Notebook_service.list_notebook_execution_jobs	source code
Notebook_service.list_notebook_runtime_templates	source code
Notebook_service.list_notebook_runtimes	source code
Notebook_service.start_notebook_runtime	source code
Notebook_service.stop_notebook_runtime	source code
Notebook_service.update_notebook_runtime_template	source code
Notebook_service.upgrade_notebook_runtime	source code
Persistent_resource_service.create_persistent_resource	source code
Persistent_resource_service.delete_persistent_resource	source code
Persistent_resource_service.get_persistent_resource	source code
Persistent_resource_service.list_persistent_resources	source code
Persistent_resource_service.reboot_persistent_resource	source code
Persistent_resource_service.update_persistent_resource	source code
Pipeline_service.batch_cancel_pipeline_jobs	source code
Pipeline_service.batch_delete_pipeline_jobs	source code
Pipeline_service.cancel_pipeline_job	source code
Pipeline_service.cancel_training_pipeline	source code
Pipeline_service.create_pipeline_job	source code
Pipeline_service.create_training_pipeline	source code
Pipeline_service.delete_pipeline_job	source code
Pipeline_service.delete_training_pipeline	source code
Pipeline_service.get_pipeline_job	source code
Pipeline_service.get_training_pipeline	source code
Pipeline_service.list_pipeline_jobs	source code
Pipeline_service.list_training_pipelines	source code
Prediction_service.direct_predict	source code
Prediction_service.direct_raw_predict	source code
Prediction_service.explain	source code
Prediction_service.generate_content	source code
Prediction_service.predict	source code
Prediction_service.raw_predict	source code
Prediction_service.server_streaming_predict	source code
Prediction_service.stream_direct_predict	source code
Prediction_service.stream_direct_raw_predict	source code
Prediction_service.stream_generate_content	source code
Prediction_service.stream_raw_predict	source code
Prediction_service.streaming_predict	source code
Prediction_service.streaming_raw_predict	source code
Schedule_service.create_schedule	source code
Schedule_service.delete_schedule	source code
Schedule_service.get_schedule	source code
Schedule_service.list_schedules	source code
Schedule_service.pause_schedule	source code
Schedule_service.resume_schedule	source code
Schedule_service.update_schedule	source code
Specialist_pool_service.create_specialist_pool	source code
Specialist_pool_service.delete_specialist_pool	source code
Specialist_pool_service.get_specialist_pool	source code
Specialist_pool_service.list_specialist_pools	source code
Specialist_pool_service.update_specialist_pool	source code
Tensorboard_service.batch_create_tensorboard_runs	source code
Tensorboard_service.batch_create_tensorboard_time_series	source code
Tensorboard_service.batch_read_tensorboard_time_series_data	source code
Tensorboard_service.create_tensorboard	source code
Tensorboard_service.create_tensorboard_experiment	source code
Tensorboard_service.create_tensorboard_run	source code
Tensorboard_service.create_tensorboard_time_series	source code
Tensorboard_service.delete_tensorboard	source code
Tensorboard_service.delete_tensorboard_experiment	source code
Tensorboard_service.delete_tensorboard_run	source code
Tensorboard_service.delete_tensorboard_time_series	source code
Tensorboard_service.export_tensorboard_time_series_data	source code
Tensorboard_service.get_tensorboard	source code
Tensorboard_service.get_tensorboard_experiment	source code
Tensorboard_service.get_tensorboard_run	source code
Tensorboard_service.get_tensorboard_time_series	source code
Tensorboard_service.list_tensorboard_experiments	source code
Tensorboard_service.list_tensorboard_runs	source code
Tensorboard_service.list_tensorboard_time_series	source code
Tensorboard_service.list_tensorboards	source code
Tensorboard_service.read_tensorboard_blob_data	source code
Tensorboard_service.read_tensorboard_size	source code
Tensorboard_service.read_tensorboard_time_series_data	source code
Tensorboard_service.read_tensorboard_usage	source code
Tensorboard_service.update_tensorboard	source code
Tensorboard_service.update_tensorboard_experiment	source code
Tensorboard_service.update_tensorboard_run	source code
Tensorboard_service.update_tensorboard_time_series	source code
Tensorboard_service.write_tensorboard_experiment_data	source code
Tensorboard_service.write_tensorboard_run_data	source code
Vizier_service.add_trial_measurement	source code
Vizier_service.check_trial_early_stopping_state	source code
Vizier_service.complete_trial	source code
Vizier_service.create_study	source code
Vizier_service.create_trial	source code
Vizier_service.delete_study	source code
Vizier_service.delete_trial	source code
Vizier_service.get_study	source code
Vizier_service.get_trial	source code
Vizier_service.list_optimal_trials	source code
Vizier_service.list_studies	source code
Vizier_service.list_trials	source code
Vizier_service.lookup_study	source code
Vizier_service.stop_trial	source code
Vizier_service.suggest_trials	source code
Dataset_service.create_dataset	source code
Dataset_service.create_dataset_version	source code
Dataset_service.delete_dataset	source code
Dataset_service.delete_dataset_version	source code
Dataset_service.delete_saved_query	source code
Dataset_service.export_data	source code
Dataset_service.get_annotation_spec	source code
Dataset_service.get_dataset	source code
Dataset_service.get_dataset_version	source code
Dataset_service.import_data	source code
Dataset_service.list_annotations	source code
Dataset_service.list_data_items	source code
Dataset_service.list_dataset_versions	source code
Dataset_service.list_datasets	source code
Dataset_service.list_saved_queries	source code
Dataset_service.restore_dataset_version	source code
Dataset_service.search_data_items	source code
Dataset_service.update_dataset	source code
Dataset_service.update_dataset_version	source code
Deployment_resource_pool_service.create_deployment_resource_pool	source code
Deployment_resource_pool_service.delete_deployment_resource_pool	source code
Deployment_resource_pool_service.get_deployment_resource_pool	source code
Deployment_resource_pool_service.list_deployment_resource_pools	source code
Deployment_resource_pool_service.query_deployed_models	source code
Deployment_resource_pool_service.update_deployment_resource_pool	source code
Endpoint_service.create_endpoint	source code
Endpoint_service.delete_endpoint	source code
Endpoint_service.deploy_model	source code
Endpoint_service.get_endpoint	source code
Endpoint_service.list_endpoints	source code
Endpoint_service.mutate_deployed_model	source code
Endpoint_service.undeploy_model	source code
Endpoint_service.update_endpoint	source code
Endpoint_service.update_endpoint_long_running	source code
Evaluation_service.evaluate_instances	source code
Extension_execution_service.execute_extension	source code
Extension_execution_service.query_extension	source code
Extension_registry_service.delete_extension	source code
Extension_registry_service.get_extension	source code
Extension_registry_service.import_extension	source code
Extension_registry_service.list_extensions	source code
Extension_registry_service.update_extension	source code
Feature_online_store_admin_service.create_feature_online_store	source code
Feature_online_store_admin_service.create_feature_view	source code
Feature_online_store_admin_service.delete_feature_online_store	source code
Feature_online_store_admin_service.delete_feature_view	source code
Feature_online_store_admin_service.get_feature_online_store	source code
Feature_online_store_admin_service.get_feature_view	source code
Feature_online_store_admin_service.get_feature_view_sync	source code
Feature_online_store_admin_service.list_feature_online_stores	source code
Feature_online_store_admin_service.list_feature_view_syncs	source code
Feature_online_store_admin_service.list_feature_views	source code
Feature_online_store_admin_service.sync_feature_view	source code
Feature_online_store_admin_service.update_feature_online_store	source code
Feature_online_store_admin_service.update_feature_view	source code
Feature_online_store_service.fetch_feature_values	source code
Feature_online_store_service.search_nearest_entities	source code
Feature_online_store_service.streaming_fetch_feature_values	source code
Feature_registry_service.batch_create_features	source code
Feature_registry_service.create_feature	source code
Feature_registry_service.create_feature_group	source code
Feature_registry_service.create_feature_monitor	source code
Feature_registry_service.create_feature_monitor_job	source code
Feature_registry_service.delete_feature	source code
Feature_registry_service.delete_feature_group	source code
Feature_registry_service.delete_feature_monitor	source code
Feature_registry_service.get_feature	source code
Feature_registry_service.get_feature_group	source code
Feature_registry_service.get_feature_monitor	source code
Feature_registry_service.get_feature_monitor_job	source code
Feature_registry_service.list_feature_groups	source code
Feature_registry_service.list_feature_monitor_jobs	source code
Feature_registry_service.list_feature_monitors	source code
Feature_registry_service.list_features	source code
Feature_registry_service.update_feature	source code
Feature_registry_service.update_feature_group	source code
Featurestore_online_serving_service.read_feature_values	source code
Featurestore_online_serving_service.streaming_read_feature_values	source code
Featurestore_online_serving_service.write_feature_values	source code
Featurestore_service.batch_create_features	source code
Featurestore_service.batch_read_feature_values	source code
Featurestore_service.create_entity_type	source code
Featurestore_service.create_feature	source code
Featurestore_service.create_featurestore	source code
Featurestore_service.delete_entity_type	source code
Featurestore_service.delete_feature	source code
Featurestore_service.delete_feature_values	source code
Featurestore_service.delete_featurestore	source code
Featurestore_service.export_feature_values	source code
Featurestore_service.get_entity_type	source code
Featurestore_service.get_feature	source code
Featurestore_service.get_featurestore	source code
Featurestore_service.import_feature_values	source code
Featurestore_service.list_entity_types	source code
Featurestore_service.list_features	source code
Featurestore_service.list_featurestores	source code
Featurestore_service.search_features	source code
Featurestore_service.update_entity_type	source code
Featurestore_service.update_feature	source code
Featurestore_service.update_featurestore	source code
Gen_ai_cache_service.create_cached_content	source code
Gen_ai_cache_service.delete_cached_content	source code
Gen_ai_cache_service.get_cached_content	source code
Gen_ai_cache_service.list_cached_contents	source code
Gen_ai_cache_service.update_cached_content	source code
Gen_ai_tuning_service.cancel_tuning_job	source code
Gen_ai_tuning_service.create_tuning_job	source code
Gen_ai_tuning_service.get_tuning_job	source code
Gen_ai_tuning_service.list_tuning_jobs	source code
Gen_ai_tuning_service.rebase_tuned_model	source code
Index_endpoint_service.create_index_endpoint	source code
Index_endpoint_service.delete_index_endpoint	source code
Index_endpoint_service.deploy_index	source code
Index_endpoint_service.get_index_endpoint	source code
Index_endpoint_service.list_index_endpoints	source code
Index_endpoint_service.mutate_deployed_index	source code
Index_endpoint_service.undeploy_index	source code
Index_endpoint_service.update_index_endpoint	source code
Index_service.create_index	source code
Index_service.delete_index	source code
Index_service.get_index	source code
Index_service.list_indexes	source code
Index_service.remove_datapoints	source code
Index_service.update_index	source code
Index_service.upsert_datapoints	source code
Job_service.cancel_batch_prediction_job	source code
Job_service.cancel_custom_job	source code
Job_service.cancel_data_labeling_job	source code
Job_service.cancel_hyperparameter_tuning_job	source code
Job_service.cancel_nas_job	source code
Job_service.create_batch_prediction_job	source code
Job_service.create_custom_job	source code
Job_service.create_data_labeling_job	source code
Job_service.create_hyperparameter_tuning_job	source code
Job_service.create_model_deployment_monitoring_job	source code
Job_service.create_nas_job	source code
Job_service.delete_batch_prediction_job	source code
Job_service.delete_custom_job	source code
Job_service.delete_data_labeling_job	source code
Job_service.delete_hyperparameter_tuning_job	source code
Job_service.delete_model_deployment_monitoring_job	source code
Job_service.delete_nas_job	source code
Job_service.get_batch_prediction_job	source code
Job_service.get_custom_job	source code
Job_service.get_data_labeling_job	source code
Job_service.get_hyperparameter_tuning_job	source code
Job_service.get_model_deployment_monitoring_job	source code
Job_service.get_nas_job	source code
Job_service.get_nas_trial_detail	source code
Job_service.list_batch_prediction_jobs	source code
Job_service.list_custom_jobs	source code
Job_service.list_data_labeling_jobs	source code
Job_service.list_hyperparameter_tuning_jobs	source code
Job_service.list_model_deployment_monitoring_jobs	source code
Job_service.list_nas_jobs	source code
Job_service.list_nas_trial_details	source code
Job_service.pause_model_deployment_monitoring_job	source code
Job_service.resume_model_deployment_monitoring_job	source code
Job_service.search_model_deployment_monitoring_stats_anomalies	source code
Job_service.update_model_deployment_monitoring_job	source code
Llm_utility_service.compute_tokens	source code
Llm_utility_service.count_tokens	source code
Match_service.find_neighbors	source code
Match_service.read_index_datapoints	source code
Metadata_service.add_context_artifacts_and_executions	source code
Metadata_service.add_context_children	source code
Metadata_service.add_execution_events	source code
Metadata_service.create_artifact	source code
Metadata_service.create_context	source code
Metadata_service.create_execution	source code
Metadata_service.create_metadata_schema	source code
Metadata_service.create_metadata_store	source code
Metadata_service.delete_artifact	source code
Metadata_service.delete_context	source code
Metadata_service.delete_execution	source code
Metadata_service.delete_metadata_store	source code
Metadata_service.get_artifact	source code
Metadata_service.get_context	source code
Metadata_service.get_execution	source code
Metadata_service.get_metadata_schema	source code
Metadata_service.get_metadata_store	source code
Metadata_service.list_artifacts	source code
Metadata_service.list_contexts	source code
Metadata_service.list_executions	source code
Metadata_service.list_metadata_schemas	source code
Metadata_service.list_metadata_stores	source code
Metadata_service.purge_artifacts	source code
Metadata_service.purge_contexts	source code
Metadata_service.purge_executions	source code
Metadata_service.query_artifact_lineage_subgraph	source code
Metadata_service.query_context_lineage_subgraph	source code
Metadata_service.query_execution_inputs_and_outputs	source code
Metadata_service.remove_context_children	source code
Metadata_service.update_artifact	source code
Metadata_service.update_context	source code
Metadata_service.update_execution	source code
Migration_service.batch_migrate_resources	source code
Migration_service.search_migratable_resources	source code
Model_garden_service.get_publisher_model	source code
Model_garden_service.list_publisher_models	source code
Model_monitoring_service.create_model_monitor	source code
Model_monitoring_service.create_model_monitoring_job	source code
Model_monitoring_service.delete_model_monitor	source code
Model_monitoring_service.delete_model_monitoring_job	source code
Model_monitoring_service.get_model_monitor	source code
Model_monitoring_service.get_model_monitoring_job	source code
Model_monitoring_service.list_model_monitoring_jobs	source code
Model_monitoring_service.list_model_monitors	source code
Model_monitoring_service.search_model_monitoring_alerts	source code
Model_monitoring_service.search_model_monitoring_stats	source code
Model_monitoring_service.update_model_monitor	source code
Model_service.batch_import_evaluated_annotations	source code
Model_service.batch_import_model_evaluation_slices	source code
Model_service.copy_model	source code
Model_service.delete_model	source code
Model_service.delete_model_version	source code
Model_service.export_model	source code
Model_service.get_model	source code
Model_service.get_model_evaluation	source code
Model_service.get_model_evaluation_slice	source code
Model_service.import_model_evaluation	source code
Model_service.list_model_evaluation_slices	source code
Model_service.list_model_evaluations	source code
Model_service.list_model_versions	source code
Model_service.list_models	source code
Model_service.merge_version_aliases	source code
Model_service.update_explanation_dataset	source code
Model_service.update_model	source code
Model_service.upload_model	source code
Notebook_service.assign_notebook_runtime	source code
Notebook_service.create_notebook_execution_job	source code
Notebook_service.create_notebook_runtime_template	source code
Notebook_service.delete_notebook_execution_job	source code
Notebook_service.delete_notebook_runtime	source code
Notebook_service.delete_notebook_runtime_template	source code
Notebook_service.get_notebook_execution_job	source code
Notebook_service.get_notebook_runtime	source code
Notebook_service.get_notebook_runtime_template	source code
Notebook_service.list_notebook_execution_jobs	source code
Notebook_service.list_notebook_runtime_templates	source code
Notebook_service.list_notebook_runtimes	source code
Notebook_service.start_notebook_runtime	source code
Notebook_service.stop_notebook_runtime	source code
Notebook_service.update_notebook_runtime_template	source code
Notebook_service.upgrade_notebook_runtime	source code
Persistent_resource_service.create_persistent_resource	source code
Persistent_resource_service.delete_persistent_resource	source code
Persistent_resource_service.get_persistent_resource	source code
Persistent_resource_service.list_persistent_resources	source code
Persistent_resource_service.reboot_persistent_resource	source code
Persistent_resource_service.update_persistent_resource	source code
Pipeline_service.batch_cancel_pipeline_jobs	source code
Pipeline_service.batch_delete_pipeline_jobs	source code
Pipeline_service.cancel_pipeline_job	source code
Pipeline_service.cancel_training_pipeline	source code
Pipeline_service.create_pipeline_job	source code
Pipeline_service.create_training_pipeline	source code
Pipeline_service.delete_pipeline_job	source code
Pipeline_service.delete_training_pipeline	source code
Pipeline_service.get_pipeline_job	source code
Pipeline_service.get_training_pipeline	source code
Pipeline_service.list_pipeline_jobs	source code
Pipeline_service.list_training_pipelines	source code
Prediction_service.chat_completions	source code
Prediction_service.count_tokens	source code
Prediction_service.direct_predict	source code
Prediction_service.direct_raw_predict	source code
Prediction_service.explain	source code
Prediction_service.generate_content	source code
Prediction_service.predict	source code
Prediction_service.raw_predict	source code
Prediction_service.server_streaming_predict	source code
Prediction_service.stream_direct_predict	source code
Prediction_service.stream_direct_raw_predict	source code
Prediction_service.stream_generate_content	source code
Prediction_service.stream_raw_predict	source code
Prediction_service.streaming_predict	source code
Prediction_service.streaming_raw_predict	source code
Reasoning_engine_execution_service.query_reasoning_engine	source code
Reasoning_engine_service.create_reasoning_engine	source code
Reasoning_engine_service.delete_reasoning_engine	source code
Reasoning_engine_service.get_reasoning_engine	source code
Reasoning_engine_service.list_reasoning_engines	source code
Reasoning_engine_service.update_reasoning_engine	source code
Schedule_service.create_schedule	source code
Schedule_service.delete_schedule	source code
Schedule_service.get_schedule	source code
Schedule_service.list_schedules	source code
Schedule_service.pause_schedule	source code
Schedule_service.resume_schedule	source code
Schedule_service.update_schedule	source code
Specialist_pool_service.create_specialist_pool	source code
Specialist_pool_service.delete_specialist_pool	source code
Specialist_pool_service.get_specialist_pool	source code
Specialist_pool_service.list_specialist_pools	source code
Specialist_pool_service.update_specialist_pool	source code
Tensorboard_service.batch_create_tensorboard_runs	source code
Tensorboard_service.batch_create_tensorboard_time_series	source code
Tensorboard_service.batch_read_tensorboard_time_series_data	source code
Tensorboard_service.create_tensorboard	source code
Tensorboard_service.create_tensorboard_experiment	source code
Tensorboard_service.create_tensorboard_run	source code
Tensorboard_service.create_tensorboard_time_series	source code
Tensorboard_service.delete_tensorboard	source code
Tensorboard_service.delete_tensorboard_experiment	source code
Tensorboard_service.delete_tensorboard_run	source code
Tensorboard_service.delete_tensorboard_time_series	source code
Tensorboard_service.export_tensorboard_time_series_data	source code
Tensorboard_service.get_tensorboard	source code
Tensorboard_service.get_tensorboard_experiment	source code
Tensorboard_service.get_tensorboard_run	source code
Tensorboard_service.get_tensorboard_time_series	source code
Tensorboard_service.list_tensorboard_experiments	source code
Tensorboard_service.list_tensorboard_runs	source code
Tensorboard_service.list_tensorboard_time_series	source code
Tensorboard_service.list_tensorboards	source code
Tensorboard_service.read_tensorboard_blob_data	source code
Tensorboard_service.read_tensorboard_size	source code
Tensorboard_service.read_tensorboard_time_series_data	source code
Tensorboard_service.read_tensorboard_usage	source code
Tensorboard_service.update_tensorboard	source code
Tensorboard_service.update_tensorboard_experiment	source code
Tensorboard_service.update_tensorboard_run	source code
Tensorboard_service.update_tensorboard_time_series	source code
Tensorboard_service.write_tensorboard_experiment_data	source code
Tensorboard_service.write_tensorboard_run_data	source code
Vertex_rag_data_service.create_rag_corpus	source code
Vertex_rag_data_service.delete_rag_corpus	source code
Vertex_rag_data_service.delete_rag_file	source code
Vertex_rag_data_service.get_rag_corpus	source code
Vertex_rag_data_service.get_rag_file	source code
Vertex_rag_data_service.import_rag_files	source code
Vertex_rag_data_service.list_rag_corpora	source code
Vertex_rag_data_service.list_rag_files	source code
Vertex_rag_data_service.update_rag_corpus	source code
Vertex_rag_data_service.upload_rag_file	source code
Vertex_rag_service.retrieve_contexts	source code
Vizier_service.add_trial_measurement	source code
Vizier_service.check_trial_early_stopping_state	source code
Vizier_service.complete_trial	source code
Vizier_service.create_study	source code
Vizier_service.create_trial	source code
Vizier_service.delete_study	source code
Vizier_service.delete_trial	source code
Vizier_service.get_study	source code
Vizier_service.get_trial	source code
Vizier_service.list_optimal_trials	source code
Vizier_service.list_studies	source code
Vizier_service.list_trials	source code
Vizier_service.lookup_study	source code
Vizier_service.stop_trial	source code
Vizier_service.suggest_trials	source code
Quickstart	source code

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