Vertex AI API C++ Client Library
An idiomatic C++ client library for the Vertex AI API, a service to train high-quality custom machine learning models with minimal machine learning expertise and effort.
While this library is GA, please note that the Google Cloud C++ client libraries do not follow Semantic Versioning.
Quickstart
The following shows the code that you'll run in the google/cloud/aiplatform/quickstart/ directory, which should give you a taste of the Vertex AI API C++ client library API.
#include "google/cloud/aiplatform/v1/endpoint_client.h"
#include "google/cloud/location.h"
#include <iostream>
int main(int argc, char* argv[]) try {
  if (argc != 3) {
    std::cerr << "Usage: " << argv[0] << " project-id location-id\n";
    return 1;
  }
  auto const location = google::cloud::Location(argv[1], argv[2]);
  namespace aiplatform = ::google::cloud::aiplatform_v1;
  auto client = aiplatform::EndpointServiceClient(
      aiplatform::MakeEndpointServiceConnection(location.location_id()));
  for (auto ep : client.ListEndpoints(location.FullName())) {
    if (!ep) throw std::move(ep).status();
    std::cout << ep->DebugString() << "\n";
  }
  return 0;
} catch (google::cloud::Status const& status) {
  std::cerr << "google::cloud::Status thrown: " << status << "\n";
  return 1;
}
Main classes
This library offers multiple *Client classes, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the *Client classes when testing your application.
- aiplatform_v1::DatasetServiceClient
- aiplatform_v1::DeploymentResourcePoolServiceClient
- aiplatform_v1::EndpointServiceClient
- aiplatform_v1::EvaluationServiceClient
- aiplatform_v1::FeatureOnlineStoreAdminServiceClient
- aiplatform_v1::FeatureOnlineStoreServiceClient
- aiplatform_v1::FeatureRegistryServiceClient
- aiplatform_v1::FeaturestoreServiceClient
- aiplatform_v1::FeaturestoreOnlineServingServiceClient
- aiplatform_v1::GenAiTuningServiceClient
- aiplatform_v1::IndexServiceClient
- aiplatform_v1::IndexEndpointServiceClient
- aiplatform_v1::JobServiceClient
- aiplatform_v1::LlmUtilityServiceClient
- aiplatform_v1::MatchServiceClient
- aiplatform_v1::MetadataServiceClient
- aiplatform_v1::MigrationServiceClient
- aiplatform_v1::ModelServiceClient
- aiplatform_v1::ModelGardenServiceClient
- aiplatform_v1::NotebookServiceClient
- aiplatform_v1::PersistentResourceServiceClient
- aiplatform_v1::PipelineServiceClient
- aiplatform_v1::PredictionServiceClient
- aiplatform_v1::ScheduleServiceClient
- aiplatform_v1::SpecialistPoolServiceClient
- aiplatform_v1::TensorboardServiceClient
- aiplatform_v1::VizierServiceClient
More Information
- Error Handling - describes how the library reports errors.
- How to Override the Default Endpoint - describes how to override the default endpoint.
- How to Override the Authentication Credentials - describes how to change the authentication credentials used by the library.
- Override Retry, Backoff, and Idempotency Policies - describes how to change the default retry policies.
- Environment Variables - describes environment variables that can configure the behavior of the library.