com.google.cloud.vertexai

Class VertexAI

java.lang.Object

com.google.cloud.vertexai.VertexAI

All Implemented Interfaces:

AutoCloseable

public class VertexAI
extends Object
implements AutoCloseable

This class holds default settings and credentials to make Vertex AI API calls.

Note: The VertexAI instance will start a service client when the first API call is made. Please close the VertexAI instance after making any API calls so that clients get closed as well.

 try (VertexAI vertexAi = new VertexAI("my-project", "us-central1"); ) {
   GenerativeModel model = new GenerativeModel("gemini-pro", vertexAi)
   // Do something with the model.
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VertexAI.Builder Builder for VertexAI.

Constructor Summary

Constructors

Constructor and Description
VertexAI() Constructs a VertexAI instance.
VertexAI(String projectId, String location) Constructs a VertexAI instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the VertexAI instance together with all its instantiated clients.
String	getApiEndpoint() Returns the default endpoint to use when making API calls.
com.google.auth.Credentials	getCredentials() Returns the default credentials to use when making API calls.
Map<String,String>	getHeaders() Returns the headers to use when making API calls.
LlmUtilityServiceClient	getLlmUtilityClient() Returns the LlmUtilityServiceClient with GRPC or REST, based on the Transport type.
String	getLocation() Returns the default location to use when making API calls.
PredictionServiceClient	getPredictionServiceClient() Returns the PredictionServiceClient with GRPC or REST, based on the Transport type.
String	getProjectId() Returns the default project to use when making API calls.
Transport	getTransport() Returns the default Transport layer to use to send API requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VertexAI

public VertexAI(String projectId,
                String location)

Constructs a VertexAI instance.

Parameters:

projectId - the default project to use when making API calls

location - the default location to use when making API calls

VertexAI

public VertexAI()

Constructs a VertexAI instance.

Note: SDK infers location from runtime environment first. If there is no location inferred from runtime environment, SDK will default location to `us-central1`.

SDK will infer projectId from runtime environment and GoogleCredentials.

Throws:

IllegalArgumentException - If there is not projectId inferred from either runtime environment or GoogleCredentials

Method Detail

getTransport

public Transport getTransport()

Returns the default Transport layer to use to send API requests.

Returns:

Transport layer used when sending API requests.

getProjectId

public String getProjectId()

Returns the default project to use when making API calls.

Returns:

Project ID in string format.

getLocation

public String getLocation()

Returns the default location to use when making API calls.

Returns:

Location in string format.

getApiEndpoint

public String getApiEndpoint()

Returns the default endpoint to use when making API calls.

Returns:

API endpoint in string format.

getHeaders

public Map<String,String> getHeaders()

Returns the headers to use when making API calls.

Returns:

a map of headers to use when making API calls.

getCredentials

public com.google.auth.Credentials getCredentials()
                                           throws IOException

Returns the default credentials to use when making API calls.

Returns:

Credentials to use when making API calls.

Throws:

IOException

getPredictionServiceClient

@InternalApi
public PredictionServiceClient getPredictionServiceClient()

Returns the PredictionServiceClient with GRPC or REST, based on the Transport type. The client will be instantiated when the first prediction API call is made.

Returns:

PredictionServiceClient that send requests to the backing service through method calls that map to the API methods.

getLlmUtilityClient

@InternalApi
public LlmUtilityServiceClient getLlmUtilityClient()

Returns the LlmUtilityServiceClient with GRPC or REST, based on the Transport type. The client will be instantiated when the first API call is made.

Returns:

LlmUtilityServiceClient that makes calls to the backing service through method calls that map to the API methods.

close

public void close()

Closes the VertexAI instance together with all its instantiated clients.

Specified by:

close in interface AutoCloseable