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::DatasetServiceClientaiplatform_v1::DeploymentResourcePoolServiceClientaiplatform_v1::EndpointServiceClientaiplatform_v1::EvaluationServiceClientaiplatform_v1::FeatureOnlineStoreAdminServiceClientaiplatform_v1::FeatureOnlineStoreServiceClientaiplatform_v1::FeatureRegistryServiceClientaiplatform_v1::FeaturestoreServiceClientaiplatform_v1::FeaturestoreOnlineServingServiceClientaiplatform_v1::GenAiTuningServiceClientaiplatform_v1::IndexServiceClientaiplatform_v1::IndexEndpointServiceClientaiplatform_v1::JobServiceClientaiplatform_v1::LlmUtilityServiceClientaiplatform_v1::MatchServiceClientaiplatform_v1::MetadataServiceClientaiplatform_v1::MigrationServiceClientaiplatform_v1::ModelServiceClientaiplatform_v1::ModelGardenServiceClientaiplatform_v1::NotebookServiceClientaiplatform_v1::PersistentResourceServiceClientaiplatform_v1::PipelineServiceClientaiplatform_v1::PredictionServiceClientaiplatform_v1::ScheduleServiceClientaiplatform_v1::SpecialistPoolServiceClientaiplatform_v1::TensorboardServiceClientaiplatform_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.