Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@google-cloud/aiplatform

googleapis441.3kApache-2.04.2.0TypeScript support: included

Vertex AI client for Node.js

google apis client, google api client, google apis, google api, google, google cloud platform, google cloud, cloud, google vertex ai, google vertex, aiplatform, dataset service, endpoint service, job service, migration service, model service, pipeline service, prediction service, specialist pool service

readme

Google Cloud Platform logo

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][projects].
  2. [Enable billing for your project][billing].
  3. [Enable the Vertex AI API][enable_api].
  4. [Set up authentication][auth] 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 ![Open in Cloud Shell][shell_img]
Dataset_service.create_dataset_version source code ![Open in Cloud Shell][shell_img]
Dataset_service.delete_dataset source code ![Open in Cloud Shell][shell_img]
Dataset_service.delete_dataset_version source code ![Open in Cloud Shell][shell_img]
Dataset_service.delete_saved_query source code ![Open in Cloud Shell][shell_img]
Dataset_service.export_data source code ![Open in Cloud Shell][shell_img]
Dataset_service.get_annotation_spec source code ![Open in Cloud Shell][shell_img]
Dataset_service.get_dataset source code ![Open in Cloud Shell][shell_img]
Dataset_service.get_dataset_version source code ![Open in Cloud Shell][shell_img]
Dataset_service.import_data source code ![Open in Cloud Shell][shell_img]
Dataset_service.list_annotations source code ![Open in Cloud Shell][shell_img]
Dataset_service.list_data_items source code ![Open in Cloud Shell][shell_img]
Dataset_service.list_dataset_versions source code ![Open in Cloud Shell][shell_img]
Dataset_service.list_datasets source code ![Open in Cloud Shell][shell_img]
Dataset_service.list_saved_queries source code ![Open in Cloud Shell][shell_img]
Dataset_service.restore_dataset_version source code ![Open in Cloud Shell][shell_img]
Dataset_service.search_data_items source code ![Open in Cloud Shell][shell_img]
Dataset_service.update_dataset source code ![Open in Cloud Shell][shell_img]
Dataset_service.update_dataset_version source code ![Open in Cloud Shell][shell_img]
Deployment_resource_pool_service.create_deployment_resource_pool source code ![Open in Cloud Shell][shell_img]
Deployment_resource_pool_service.delete_deployment_resource_pool source code ![Open in Cloud Shell][shell_img]
Deployment_resource_pool_service.get_deployment_resource_pool source code ![Open in Cloud Shell][shell_img]
Deployment_resource_pool_service.list_deployment_resource_pools source code ![Open in Cloud Shell][shell_img]
Deployment_resource_pool_service.query_deployed_models source code ![Open in Cloud Shell][shell_img]
Deployment_resource_pool_service.update_deployment_resource_pool source code ![Open in Cloud Shell][shell_img]
Endpoint_service.create_endpoint source code ![Open in Cloud Shell][shell_img]
Endpoint_service.delete_endpoint source code ![Open in Cloud Shell][shell_img]
Endpoint_service.deploy_model source code ![Open in Cloud Shell][shell_img]
Endpoint_service.get_endpoint source code ![Open in Cloud Shell][shell_img]
Endpoint_service.list_endpoints source code ![Open in Cloud Shell][shell_img]
Endpoint_service.mutate_deployed_model source code ![Open in Cloud Shell][shell_img]
Endpoint_service.undeploy_model source code ![Open in Cloud Shell][shell_img]
Endpoint_service.update_endpoint source code ![Open in Cloud Shell][shell_img]
Endpoint_service.update_endpoint_long_running source code ![Open in Cloud Shell][shell_img]
Evaluation_service.evaluate_instances source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.create_feature_online_store source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.create_feature_view source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.delete_feature_online_store source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.delete_feature_view source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.get_feature_online_store source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.get_feature_view source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.get_feature_view_sync source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.list_feature_online_stores source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.list_feature_view_syncs source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.list_feature_views source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.sync_feature_view source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.update_feature_online_store source code ![Open in Cloud Shell][shell_img]
Feature_online_store_admin_service.update_feature_view source code ![Open in Cloud Shell][shell_img]
Feature_online_store_service.fetch_feature_values source code ![Open in Cloud Shell][shell_img]
Feature_online_store_service.search_nearest_entities source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.batch_create_features source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.create_feature source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.create_feature_group source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.delete_feature source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.delete_feature_group source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.get_feature source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.get_feature_group source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.list_feature_groups source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.list_features source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.update_feature source code ![Open in Cloud Shell][shell_img]
Feature_registry_service.update_feature_group source code ![Open in Cloud Shell][shell_img]
Featurestore_online_serving_service.read_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_online_serving_service.streaming_read_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_online_serving_service.write_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_service.batch_create_features source code ![Open in Cloud Shell][shell_img]
Featurestore_service.batch_read_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_service.create_entity_type source code ![Open in Cloud Shell][shell_img]
Featurestore_service.create_feature source code ![Open in Cloud Shell][shell_img]
Featurestore_service.create_featurestore source code ![Open in Cloud Shell][shell_img]
Featurestore_service.delete_entity_type source code ![Open in Cloud Shell][shell_img]
Featurestore_service.delete_feature source code ![Open in Cloud Shell][shell_img]
Featurestore_service.delete_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_service.delete_featurestore source code ![Open in Cloud Shell][shell_img]
Featurestore_service.export_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_service.get_entity_type source code ![Open in Cloud Shell][shell_img]
Featurestore_service.get_feature source code ![Open in Cloud Shell][shell_img]
Featurestore_service.get_featurestore source code ![Open in Cloud Shell][shell_img]
Featurestore_service.import_feature_values source code ![Open in Cloud Shell][shell_img]
Featurestore_service.list_entity_types source code ![Open in Cloud Shell][shell_img]
Featurestore_service.list_features source code ![Open in Cloud Shell][shell_img]
Featurestore_service.list_featurestores source code ![Open in Cloud Shell][shell_img]
Featurestore_service.search_features source code ![Open in Cloud Shell][shell_img]
Featurestore_service.update_entity_type source code ![Open in Cloud Shell][shell_img]
Featurestore_service.update_feature source code ![Open in Cloud Shell][shell_img]
Featurestore_service.update_featurestore source code ![Open in Cloud Shell][shell_img]
Gen_ai_cache_service.create_cached_content source code ![Open in Cloud Shell][shell_img]
Gen_ai_cache_service.delete_cached_content source code ![Open in Cloud Shell][shell_img]
Gen_ai_cache_service.get_cached_content source code ![Open in Cloud Shell][shell_img]
Gen_ai_cache_service.list_cached_contents source code ![Open in Cloud Shell][shell_img]
Gen_ai_cache_service.update_cached_content source code ![Open in Cloud Shell][shell_img]
Gen_ai_tuning_service.cancel_tuning_job source code ![Open in Cloud Shell][shell_img]
Gen_ai_tuning_service.create_tuning_job source code ![Open in Cloud Shell][shell_img]
Gen_ai_tuning_service.get_tuning_job source code ![Open in Cloud Shell][shell_img]
Gen_ai_tuning_service.list_tuning_jobs source code ![Open in Cloud Shell][shell_img]
Gen_ai_tuning_service.rebase_tuned_model source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.create_index_endpoint source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.delete_index_endpoint source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.deploy_index source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.get_index_endpoint source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.list_index_endpoints source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.mutate_deployed_index source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.undeploy_index source code ![Open in Cloud Shell][shell_img]
Index_endpoint_service.update_index_endpoint source code ![Open in Cloud Shell][shell_img]
Index_service.create_index source code ![Open in Cloud Shell][shell_img]
Index_service.delete_index source code ![Open in Cloud Shell][shell_img]
Index_service.get_index source code ![Open in Cloud Shell][shell_img]
Index_service.list_indexes source code ![Open in Cloud Shell][shell_img]
Index_service.remove_datapoints source code ![Open in Cloud Shell][shell_img]
Index_service.update_index source code ![Open in Cloud Shell][shell_img]
Index_service.upsert_datapoints source code ![Open in Cloud Shell][shell_img]
Job_service.cancel_batch_prediction_job source code ![Open in Cloud Shell][shell_img]
Job_service.cancel_custom_job source code ![Open in Cloud Shell][shell_img]
Job_service.cancel_data_labeling_job source code ![Open in Cloud Shell][shell_img]
Job_service.cancel_hyperparameter_tuning_job source code [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-aiplatform/samples/generated/v1/job_service.cancel_hyperparam

changelog

Changelog

4.2.0 (2025-05-09)

Features

  • Multiple ai-platform updates (0b8b1a7)

4.1.0 (2025-03-19)

Features

  • [Many APIs] await/catch promises, and update listOperationsAsync return type (#6182) (c41ff07)

4.0.0 (2025-03-18)

⚠ BREAKING CHANGES

  • upgrade to Node 18 (#6096)

Miscellaneous Chores

3.35.0 (2025-02-28)

Features

  • A new field create_time is added to message .google.cloud.aiplatform.v1.GenerateContentResponse (fdef07b)
  • A new field create_time is added to message .google.cloud.aiplatform.v1.GenerateContentResponse (fdef07b)
  • A new field list_all_versions to ListPublisherModelsRequest (fdef07b)
  • A new field response_id is added to message .google.cloud.aiplatform.v1.GenerateContentResponse (fdef07b)
  • A new value NVIDIA_H100_MEGA_80GB is added to enum AcceleratorType (fdef07b)
  • A new value NVIDIA_H100_MEGA_80GB is added to enum AcceleratorType (fdef07b)
  • Add a new thought field in content proto (fdef07b)
  • Add additional Probe options to v1 model.proto (fdef07b)
  • Add Context Cache to v1 (fdef07b)
  • Add GenerationConfig.MediaResolution (fdef07b)
  • Add GenerationConfig.Modality (fdef07b)
  • Add GenerationConfig.SpeechConfig (fdef07b)
  • Add LLM parser proto to API (fdef07b)
  • Add machine_spec, data_persistent_disk_spec, network_spec, euc_config, shielded_vm_config to .google.cloud.aiplatform.v1beta1.NotebookRuntime (fdef07b)
  • Add machine_spec, data_persistent_disk_spec, network_spec, euc_config, shielded_vm_config to message .google.cloud.aiplatform.v1.NotebookRuntime (fdef07b)
  • Add Model Garden deploy API (fdef07b)
  • Add Model Garden deploy API (#5836) (fdef07b)
  • Add new RequiredReplicaCount field to DedicatedResources in MachineResources (fdef07b)
  • Add new RequiredReplicaCount field to DedicatedResources in MachineResources (fdef07b)
  • Add new Status field to DeployedModel in Endpoint (fdef07b)
  • Add new Status field to DeployedModel in Endpoint (fdef07b)
  • Add Notebooks Runtime Software Configuration (fdef07b)
  • Add Notebooks Runtime Software Configuration (fdef07b)
  • Add optimized config in v1 API (fdef07b)
  • Add per-modality token count break downs for GenAI APIs (fdef07b)
  • Add per-modality token count break downs for GenAI APIs (fdef07b)
  • Add rag_files_count to RagCorpus to count number of associated files (fdef07b)
  • Add retrieval_config to ToolConfig v1 (fdef07b)
  • Add retrieval_config to ToolConfig v1beta1 (fdef07b)
  • Add RolloutOptions to DeployedModel in v1beta1 endpoint.proto, add additional Probe options in v1beta1 model.proto (fdef07b)
  • Add speculative decoding spec to DeployedModel proto (fdef07b)
  • Add Tool.GoogleSearch (fdef07b)
  • Add Vertex RAG service proto to v1 (fdef07b)
  • Add workbench_runtime and kernel_name to NotebookExecutionJob (fdef07b)
  • Add workbench_runtime and kernel_name to NotebookExecutionJob (fdef07b)
  • Enable FeatureGroup IAM Methods in v1beta1 API version (fdef07b)
  • Enable FeatureGroup Service Account and IAM methods (fdef07b)
  • Enable FeatureView Service Account in v1 API version (fdef07b)
  • Enable UpdateFeatureMonitor in v1beta1 API version (fdef07b)
  • EvaluateDataset API v1beta1 initial release (fdef07b)
  • Expose code execution tool API to v1 (fdef07b)
  • Introduce HybridSearch and Ranking configuration for RAG (fdef07b)
  • Introduce VertexAiSearch integration for RAG (fdef07b)
  • Model Registry Checkpoint API (fdef07b)
  • Model Registry Checkpoint API (fdef07b)
  • Paging changes for bigquery (fdef07b)
  • Reasoning Engine v1 GAPIC release (fdef07b)
  • Remove autorater config related visibility v1beta1 (fdef07b)
  • Support streaming and multi class methods in Reasoning Engine v1beta1 API (fdef07b)

Bug Fixes

  • Add x-goog-request params to headers for LRO-polling methods (fdef07b)
  • Finalize fixing typings for headers in generator (fdef07b)
  • Fix typings for headers in generator (fdef07b)
  • Remove extra protos in ESM & capture ESM in headers (fdef07b)

3.34.0 (2024-11-21)

Features

3.33.0 (2024-11-14)

Features

  • Add fast_tryout_enabled to FasterDeploymentConfig v1 proto (#5781) (3cc221d)

3.32.0 (2024-10-30)

Features

3.31.0 (2024-10-10)

Features

  • Add partner_model_tuning_spec to TuningJob (#5721) (cec22ab)

3.30.1 (2024-10-10)

Bug Fixes

  • Annotate PipelineJob and PipelineTaskRerunConfig fields as optional (#5698) (183c038)

3.30.0 (2024-09-24)

Features

  • A new field response_logprbs is added to message .google.cloud.aiplatform.v1.GenerationConfig (#5664) (100e106)

3.29.0 (2024-09-10)

Features

  • Add more configurability to feature_group.proto (#5656) (9760c20)
  • Add Vector DB config for Vertex RAG (Weaviate + FeatureStore) (#5648) (d62f18a)

3.28.0 (2024-08-29)

Features

3.27.0 (2024-08-19)

Features

  • A new field satisfies_pzs is added to message .google.cloud.aiplatform.v1.BatchPredictionJob (#5605) (e4574ad)

3.26.0 (2024-08-09)

Features

  • A new field score is added to message .google.cloud.aiplatform.v1.Candidate (#5577) (1abd9a7)

3.25.0 (2024-07-10)

Features

  • Add model and contents fields to ComputeTokensRequest v1 (#5517) (8983209)
  • Enable rest_numeric_enums for aiplatform v1 and v1beta1 (#5531) (2359c34)

3.24.0 (2024-06-26)

Features

  • Add MALFORMED_FUNCTION_CALL to FinishReason (#5481) (83498e9)

3.23.0 (2024-06-05)

Features

  • Add rag_embedding_model_config to RagCorpus (#5430) (a1aba11)

3.22.0 (2024-06-03)

Features

3.21.0 (2024-05-21)

Features

  • [Many APIs] update Nodejs generator to send API versions in headers for GAPICs (#5351) (01f48fc)
  • [Many APIs] update Nodejs generator to send API versions in headers for GAPICs (#5354) (a9784ed)
  • Update Nodejs generator to send API versions in headers for GAPICs (#5343) (d129760)

3.20.0 (2024-05-02)

Features

  • A new field search_entry_point is added to message .google.cloud.aiplatform.v1beta1.GroundingMetadata (#5285) (fe2a4e3)

3.19.1 (2024-04-23)

Bug Fixes

  • Delete the deprecated field for model monitor (#5274) (ae521e6)

3.19.0 (2024-04-18)

Features

  • Add model_monitor resource and APIs to public v1beta1 client library (#5234) (cecd67c)

3.18.0 (2024-04-10)

Features

  • Add Persistent Resource reboot api call to v1beta1 (#5182) (c271d54)

3.17.0 (2024-03-26)

Features

  • Add Optimized feature store proto (#5153) (1f5d99c)
  • Evaluation Service aiplatform v1beta1 initial release (#5172) (6827acc)

3.16.0 (2024-03-23)

Features

  • Add v1beta1 StreamingFetchFeatureValues API (#5128) (4849a58)

3.15.0 (2024-03-12)

Features

  • A new value NVIDIA_H100_80GB is added to enum AcceleratorType (#5114) (729d778)

3.14.0 (2024-02-27)

Features

  • Add CompositeKey message and composite_key field to FeatureViewDataKey (#5072) (b643f04)

3.13.0 (2024-02-22)

Features

  • Add point_of_contact to Feature message (#5064) (d158bfb)
  • Add Grounding feature to PredictionService.GenerateContent (#5036) (6b73cce)

3.12.0 (2024-02-09)

Features

  • Trusted Private Cloud support, use the universeDomain parameter (#5021) (ca9af37)

3.11.0 (2024-02-07)

Features

  • Add generateContent Unary API for aiplatform_v1 (#5003) (8722b31)

3.10.1 (2024-01-23)

Bug Fixes

  • Improve retry logic for streaming API calls (#4942) (0bca99d)

3.10.0 (2024-01-05)

Features

3.9.0 (2023-12-11)

Features

3.8.0 (2023-11-30)

Features

  • Add grpc_ports to UploadModel ModelContainerSpec (#4836) (736ff8b)

3.7.0 (2023-11-16)

Features

  • [aiplatform] add protected_artifact_location_id to CustomJob (#4809) (9da9501)

3.6.0 (2023-11-09)

Features

3.5.0 (2023-11-03)

Features

  • Adding new fields for concurrent explanations (489e188)

Bug Fixes

  • aiplatform/v1beta1: Change CreateFeature metadata (#4782) (489e188)

3.4.0 (2023-10-24)

Features

  • Add DatasetVersion and dataset version RPCs to DatasetService (#4726) (a515212)

3.3.0 (2023-10-18)

Features

3.2.0 (2023-09-11)

Features

  • Add encryption_spec to index.proto and index_endpoint.proto (#4596) (32d823a)

3.1.0 (2023-09-06)

Features

  • Add NVIDIA_H100_80GB and TPU_V5_LITEPOD to AcceleratorType (#4557) (7253ef1)

Bug Fixes

  • [Many APIs] simplify logic for HTTP/1.1 REST fallback option (#4583) (c3ddba8)

3.0.0 (2023-08-06)

⚠ BREAKING CHANGES

  • migrate to Node 14 (#4443)

Features

  • Add PredictionService.ServerStreamingPredict method (#4439) (44d81b3)
  • Add RaySepc to ResourceRuntimeSpec, and add ResourceRuntime to PersistentResource (#4470) (d58a096)

Miscellaneous Chores

2.17.0 (2023-07-24)

Features

2.16.0 (2023-06-28)

Features

2.15.0 (2023-06-06)

Features

  • [ai-platform] add blocking_operation_ids to ImportFeatureValuesOperationMetadata (#4284) (99736a9)

Bug Fixes

  • [ai-platform] update typings for helpers, updated docstrings; removed stale comment (#4312) (b2c4f46)

2.14.0 (2023-05-20)

Features

  • Add updateSchedule method to ScheduleService (#4280) (d1e67be)

2.13.0 (2023-05-09)

Features

  • Add example_gcs_source to Examples in aiplatform v1beta1 explanation.proto (#4249) (4af8ae2)

2.12.0 (2023-05-04)

Features

  • Add model_garden_service.proto and publisher_model.proto to BUILD.bazel (#4225) (5367d25)

2.11.0 (2023-05-02)

Features

  • Add experiment and experiment_run to CustomJobSpec (20eafa1)
  • Add GENIE to ModelSourceType (20eafa1)
  • Add MutateDeployedModel RPC to endpoint_service (20eafa1)
  • Add NVIDIA_L4 to AcceleratorType (20eafa1)
  • Add NVIDIA_L4 to AcceleratorType (#4216) (20eafa1)
  • Add offline_storage_ttl_days to EntityType (20eafa1)
  • Add online_storage_ttl_days to FeatureStore (20eafa1)

2.10.0 (2023-04-24)

Features

  • Add is_default to Tensorboard in aiplatform v1 tensorboard.proto and v1beta1 tensorboard.proto (#4179) (3c46888)

2.9.0 (2023-04-13)

Features

  • [ai-platform] add public_endpoint_enabled and publid_endpoint_domain_name to IndexEndpoint (#4136) (94ea195)
  • Add notification_channels in aiplatform v1beta1 model_monitoring.proto (#4160) (c56a74d)

Bug Fixes

2.8.1 (2023-03-28)

Bug Fixes

  • Remove large_model_reference from Model in aiplatform v1beta1 model.proto (#4098) (3c1a0ee)

2.8.0 (2023-03-06)

Features

  • Add disable_container_logging to BatchPredictionJob in aiplatform v1,v1beta1 batch_prediction_job.proto (#4052) (735af33)

2.7.0 (2023-02-22)

Features

  • Add match service in aiplatform v1beta1 match_service.proto (#4002) (e2944f5)

2.6.1 (2023-02-15)

Bug Fixes

  • [Many APIs] changing format of the jsdoc links (#3985) (fb2a6fd)

2.6.0 (2023-02-09)

Features

  • [ai-platform] add service_networking.proto to aiplatform v1 (#3937) (fcaacbc)

2.5.0 (2023-01-28)

Features

  • Add enable_dashboard_access in aiplatform v1 and v1beta1 (#460) (58d9da5)

Bug Fixes

  • Removing migrated samples (to nodejs-docs-samples) from repo (#555) (c97bb20)

2.4.0 (2023-01-25)

Features

  • Add enable_dashboard_access in aiplatform v1 and v1beta1 (#460) (685cfed)

Bug Fixes

  • deps: Use google-gax v3.5.2 (#458) (9345b15)
  • Removing migrated samples (to nodejs-docs-samples) from repo (#555) (0864901)

2.3.0 (2022-09-21)

Features

  • Add deleteFeatureValues in aiplatform v1beta1 featurestore_service.proto (#371) (e1c5cd6)
  • Add timestamp_outside_retention_rows_count, RemoveContextChildren, order_by, InputArtifact, read_mask, TransferLearningConfig (#450) (3a3f71f)

Bug Fixes

  • Allow passing gax instance to client constructor (#365) (6200e38)
  • Preserve default values in x-goog-request-params header (#370) (6860cfd)

2.2.0 (2022-08-27)

Features

  • add a DeploymentResourcePool API resource_definition (fa3c209)
  • add DeploymentResourcePool in aiplatform v1beta1 deployment_resource_pool.proto (fa3c209)
  • add DeploymentResourcePoolService in aiplatform v1beta1 deployment_resource_pool_service.proto (fa3c209)
  • add shared_resources for supported prediction_resources (fa3c209)
  • add SHARED_RESOURCES to DeploymentResourcesType in aiplatform v1beta1 model.proto (fa3c209)
  • add WriteFeatureValues in aiplatform v1beta1 featurestore_online_service.proto (fa3c209)
  • added SHARED_RESOURCES enum to aiplatform v1 model.proto (fa3c209)
  • DeploymentResourcePool and DeployementResourcePoolService added to aiplatform v1beta1 model.proto (cl/463147866) (fa3c209)
  • making network arg optional in aiplatform v1 custom_job.proto (fa3c209)
  • making network arg optional in aiplatform v1beta1 custom_job.proto (fa3c209)
  • samples: add entity type apis samples (#339) (5bb18f3)
  • samples: add feature apis samples (#340) (90dcec7)
  • samples: add feature values apis samples (#341) (4cef015)
  • samples: add remaining featurestore api samples (#338) (f136458)

Bug Fixes

2.1.0 (2022-07-04)

Features

  • add BatchImportModelEvaluationSlices API in aiplatform v1 model_service.proto (0a7e609)
  • add ListSavedQueries rpc to aiplatform v1 dataset_service.proto (0a7e609)
  • add ListSavedQueries rpc to aiplatform v1beta1 dataset_service.proto (0a7e609)
  • add monitor_window to ModelDeploymentMonitoringScheduleConfig proto in aiplatform v1/v1beta1 model_deployment_monitoring_job.proto (0a7e609)
  • add saved_query_id to InputDataConfig in aiplatform v1 training_pipeline.proto (0a7e609)
  • add saved_query_id to InputDataConfig in aiplatform v1beta1 training_pipeline.proto (0a7e609)
  • add saved_query.proto to aiplatform v1 (0a7e609)
  • add saved_query.proto to aiplatform v1beta1 (0a7e609)

2.0.0 (2022-06-23)

⚠ BREAKING CHANGES

  • update library to use Node 12 (#304)

Features

  • add ConvexAutomatedStoppingSpec to StudySpec in aiplatform v1beta1 study.proto (863748a)
  • add display_name and metadata to ModelEvaluation in aiplatform model_evaluation.proto (#297) (1e6dcb6)
  • add Examples to Explanation related messages in aiplatform v1beta1 explanation.proto (#307) (c69ac2b)
  • add IAM policy to aiplatform_v1beta1.yaml (#308) (6557767)
  • add JOB_STATE_UPDATING to JobState in aiplatform v1beta1 job_state.proto (863748a)
  • add LatestMonitoringPipelineMetadata to ModelDeploymentMonitoringJob in aiplatform v1beta1 model_deployment_monitoring_job.proto (863748a)
  • add ListModelVersion, DeleteModelVersion, and MergeVersionAliases rpcs to aiplatform v1beta1 model_service.proto (863748a)
  • add MfsMount in aiplatform v1beta1 machine_resources.proto (863748a)
  • add model_id and parent_model to TrainingPipeline in aiplatform v1beta1 training_pipeline.proto (863748a)
  • add model_version_id to DeployedModel in aiplatform v1beta1 endpoint.proto (863748a)
  • add model_version_id to PredictResponse in aiplatform v1beta1 prediction_service.proto (863748a)
  • add model_version_id to UploadModelRequest and UploadModelResponse in aiplatform v1beta1 model_service.proto (863748a)
  • add nfs_mounts to WorkPoolSpec in aiplatform v1beta1 custom_job.proto (863748a)
  • add PredictRequestResponseLoggingConfig to aiplatform v1beta1 endpoint.proto (863748a)
  • add reserved_ip_ranges to CustomJobSpec in aiplatform v1 custom_job.proto (#286) (863748a)
  • add reserved_ip_ranges to CustomJobSpec in aiplatform v1beta1 custom_job.proto (863748a)
  • add version_id to Model in aiplatform v1beta1 model.proto (863748a)
  • rename Similarity to Examples, and similarity to examples in ExplanationParameters in aiplatform v1beta1 explanation.proto (863748a)
  • samples: add create-featurestore samples (#317) (5876d81)

Bug Fixes

Build System

1.19.0 (2022-03-24)

Features

  • add data_item_schema_uri, annotation_schema_uri, explanation_specs to ModelEvaluationExplanationSpec in aiplatform v1 model_evaluation.proto (b769264)
  • add ImportModelEvaluation in aiplatform v1 model_service.proto (#280) (b769264)
  • add ImportModelEvaluation in aiplatform v1beta1 model_service.proto (b769264)

1.18.0 (2022-03-17)

Features

  • add service_account to BatchPredictionJob in aiplatform v1beta1 batch_prediction_job.proto (#278) (1f05428)

1.17.0 (2022-03-14)

Features

  • add monitoring_config to EntityType in aiplatform v1 entity_type.proto (#277) (d9b8b06)
  • add PredictRequestResponseLoggingConfig to Endpoint in aiplatform v1 endpoint.proto (#275) (3e5dc67)

1.16.0 (2022-02-22)

Features

  • add TPU_V2 & TPU_V3 values to AcceleratorType in aiplatform v1/v1beta1 accelerator_type.proto (#269) (6e9290f)

1.15.0 (2022-02-08)

Features

  • add dedicated_resources to DeployedIndex in aiplatform v1beta1 index_endpoint.proto feat: add Scaling to OnlineServingConfig in aiplatform v1beta1 featurestore.proto chore: sort imports (#262) (f3e31ec)
  • add dedicated_resources to DeployedIndex message in aiplatform v1 index_endpoint.proto chore: sort imports (#261) (8f7e61e)

1.14.1 (2022-01-13)

Bug Fixes

1.14.0 (2021-12-11)

Features

  • add enable_private_service_connect field to Endpoint (#238) (bac788d)
  • add enable_private_service_connect field to Endpoint (#239) (e9cbc46)
  • add endpoint_id to CreateEndpointRequest and method signature to CreateEndpoint (e9cbc46)
  • add id field to DeployedModel (e9cbc46)
  • add method signature to CreateFeatureStore, CreateEntityType, CreateFeature (e9cbc46)
  • add network and enable_private_service_connect to IndexEndpoint (e9cbc46)
  • add service_attachment field to PrivateEndpoints (e9cbc46)
  • add service_attachment to IndexPrivateEndpoints (e9cbc46)
  • add stratified_split field to training_pipeline InputDataConfig (e9cbc46)
  • Exposing a field for v1 CustomJob-Tensorboard integration. (03881ff)
  • Tensorboard v1 protos release (#234) (03881ff)

1.13.0 (2021-11-11)

Features

  • Adds support for google.protobuf.Value pipeline parameters in the parameter_values field (#218) (d05a598)

1.12.0 (2021-10-27)

Features

  • add featurestore service to aiplatform v1 feat: add metadata service to aiplatform v1 (#211) (b8a92f2)
  • add Similarity to explanation in aiplatform v1beta1 feat: add EncryptionSpec to featurestore in aiplatform v1beta1 feat: add PipelineTaskStatus to pipeline_job in aiplatform v1beta1 feat: add BatchReadTensorboardTimeSeriesData to tensorboard_serv... (#210) (ae37fb8)
  • add vizier service to aiplatform v1 (#205) (4d37e14)

Bug Fixes

1.11.0 (2021-09-22)

Features

  • add deployment_group to DeployedIndex in aiplatform_v1beta1 (35b45f1)
  • add model_deployment_monitoring_job to Endpoint in aiplatform_v1beta1 (35b45f1)
  • add ModelEvaluationExplanationSpec in aiplatform_v1beta1 (35b45f1)
  • add prediction service RPC RawPredict to aiplatform_v1beta1 feat: add tensorboard service RPCs to aiplatform_v1beta1: BatchCreateTensorboardRuns, BatchCreateTensorboardTimeSeries, WriteTensorboardExperimentData feat: add model_deployment_monitori... (#196) (35b45f1)
  • add tensorboard service RPCs to aiplatform_v1beta1: BatchCreateTensorboardRuns, BatchCreateTensorboardTimeSeries, WriteTensorboardExperimentData (35b45f1)
  • add Vizier service to aiplatform v1 (#197) (7da1062)
  • turns on self-signed JWT feature flag (#191) (7e9b76f)

Bug Fixes

1.10.1 (2021-08-09)

Bug Fixes

1.10.0 (2021-07-23)

Features

  • Adds BigQuery output table field to batch prediction job output config (22f1f67)
  • Adds CustomJob.web_access_uris, CustomJob.enable_web_access fields (22f1f67)
  • Adds Endpoint.network, Endpoint.private_endpoints fields and PrivateEndpoints message (22f1f67)
  • Adds Execution.State constants: CACHED and CANCELLED (22f1f67)
  • Adds Feature Store features (22f1f67)
  • Adds fields to Study message (22f1f67)
  • Adds IndexEndpoint.private_ip_ranges field (22f1f67)
  • Adds IndexEndpointService.deployed_index_id field (22f1f67)
  • Adds MetadataService.DeleteArtifact and DeleteExecution methods (22f1f67)
  • Adds ModelMonitoringObjectConfig.explanation_config field and ModelMonitoringObjectConfig.ExplanationConfig message (22f1f67)
  • Adds ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig.attribution_score_skew_thresholds and ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig.attribution_score_drift_threshold fields (22f1f67)
  • Removes breaking change from v1 version of AI Platform protos (22f1f67)

1.9.1 (2021-07-21)

Bug Fixes

  • Updating WORKSPACE files to use the newest version of the Typescript generator. (#172) (d22eceb)

1.9.0 (2021-07-15)

Features

  • Adds additional_experiments field to AutoMlTablesInputs (#170) (4a0a502)

1.8.0 (2021-07-14)

Features

  • Removes AcceleratorType.TPU_V2 and TPU_V3 constants (#167) (72d153e)

1.7.4 (2021-07-12)

Bug Fixes

1.7.3 (2021-06-29)

Bug Fixes

  • add C#, PHP and Ruby options for all AI Platform protos (#158) (da0babf)
  • deps: google-gax v2.17.0 with mTLS (#161) (8e7d46f)

1.7.2 (2021-06-22)

Bug Fixes

1.7.1 (2021-06-02)

Bug Fixes

  • GoogleAdsError missing using generator version after 1.3.0 (#141) (743c71b)

1.7.0 (2021-05-11)

⚠ BREAKING CHANGES

  • BREAKING_CHANGE: remove display_name from FeatureStore feat: add invalid_row_count to ImportFeatureValuesResponse and ImportFeatureValuesOperationMetadata (#124)
  • BREAKING CHANGE: remove unsupported accelerator types feat: add aiplatform API Vizier service (#92)

Features

  • add featurestore, index, metadata, monitoring, pipeline, and tensorboard services to aiplatform v1beta1. (#118) (c3ce821)
  • BREAKING CHANGE: remove unsupported accelerator types feat: add aiplatform API Vizier service (#92) (23f184d)

Bug Fixes

  • BREAKING_CHANGE: remove display_name from FeatureStore feat: add invalid_row_count to ImportFeatureValuesResponse and ImportFeatureValuesOperationMetadata (#124) (34b8548)
  • deps: require google-gax v2.12.0 (#120) (2b58ecb)
  • use require() to load JSON protos (#122) (3f26575)

1.6.0 (2021-03-11)

Features

  • removes forecasting (time_series_forecasting.proto) from public v1beta1 protos (#86) (ccc1953)

Bug Fixes

1.5.0 (2021-02-17)

Features

  • ImageSegmentationPredictionResult.category_mask field changed to string data type (#76) (ec47129)

1.4.0 (2021-02-12)

Features

  • add encryption_spec to aiplatform v1beta1 (#63) (c3256aa)
  • adds v1 version of library (#70) (5a1b765)
  • samples: add additional samples to library (#25) (5a7f5db)
  • updates enhanced client library veneer and samples (#73) (59e293f)

Bug Fixes

  • reduces image object detection test file size (#69) (fb4308c)

1.3.0 (2021-01-14)

Features

  • samples: adds samples for enhanced version of library (#16) (aef443c)

1.2.0 (2021-01-09)

Features

  • adds cleaner utility for orphaned resources (#34) (7c09258)
  • adds style enumeration (#37) (81c1515)

1.1.0 (2021-01-07)

Features

1.0.0 (2020-11-10)

⚠ BREAKING CHANGES

  • initial generation of library (#4)

Features