This page shows how to get started with the Cloud Client Libraries for the Vertex AI API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write.
Read more about the Cloud Client Libraries and the older Google API Client Libraries in Client libraries explained.
Install the client library
C#
Install-Package Google.Cloud.AIPlatform.V1 -Pre
For more information, see Setting Up a C# Development Environment.
Go
go get cloud.google.com/go/vertexai/genai
For more information, see Setting Up a Go Development Environment.
Java
If you are using Maven with BOM, add the following in your pom.xml:
<dependencyManagement> <dependencies> <dependency> <groupId>com.google.cloud</groupId> <artifactId>libraries-bom</artifactId> <version>26.34.0</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>com.google.cloud</groupId> <artifactId>google-cloud-vertexai</artifactId> </dependency> </dependencies>
If you are using Maven without BOM, add the following to your pom.xml:
<dependency> <groupId>com.google.cloud</groupId> <artifactId>google-cloud-vertexai</artifactId> <version>1.1.0</version> </dependency>
If you are using Gradle without BOM, add the following to your build.gradle:
implementation 'com.google.cloud:google-cloud-vertexai:1.1.0'
For more information, see Setting Up a Java Development Environment.
Node.js
npm install --save @google-cloud/vertexai
For more information, see Setting Up a Node.js Development Environment.
Python
pip install --upgrade google-cloud-aiplatform
For more information, see Setting Up a Python Development Environment.
Set up authentication
To authenticate calls to Google Cloud APIs, client libraries support Application Default Credentials (ADC); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.For production environments, the way you set up ADC depends on the service and context. For more information, see Set up Application Default Credentials.
For a local development environment, you can set up ADC with the credentials that are associated with your Google Account:
-
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
-
Create local authentication credentials for your user account:
gcloud auth application-default login
A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.
Use the client library
The following example shows how to use the client library.
C#
Go
Java
Node.js
Python
Additional resources
C#
The following list contains links to more resources related to the client library for C#:
Go
The following list contains links to more resources related to the client library for Go:
Java
The following list contains links to more resources related to the client library for Java:
Node.js
The following list contains links to more resources related to the client library for Node.js:
Python
The following list contains links to more resources related to the client library for Python: