Package com.google.genai

Class Client

java.lang.Object

com.google.genai.Client

All Implemented Interfaces:

AutoCloseable

public final class Client
extends Object
implements AutoCloseable

Client class for GenAI. This class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	Client.Async	Async class for GenAI.
static class	Client.Builder	Builder for Client.

Field Summary

Fields

Modifier and Type	Field	Description
final Client.Async	async
final Batches	batches
final Caches	caches
final Chats	chats
final Files	files
final Models	models
final Operations	operations
final Tunings	tunings

Constructor Summary

Constructors

Constructor	Description
Client()	Constructs a Client instance with environment variables.

Method Summary

Modifier and Type	Method	Description
String	apiKey()	Returns the API key for Gemini API.
static Client.Builder	builder()	Returns a Client.Builder for Client.
void	close()	Closes the Client instance together with its instantiated http client.
String	location()	Returns the location for Vertex AI APIs.
String	project()	Returns the project ID for Vertex AI APIs.
static void	setDefaultBaseUrls(Optional<String> geminiBaseUrl, Optional<String> vertexBaseUrl)	Overrides the base URLs for the Gemini API and/or Vertex AI API.
boolean	vertexAI()	Returns whether the client is using Vertex AI APIs.

Methods inherited from class java.lang.Object

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

Field Details

models

public final Models models

batches

public final Batches batches

caches

public final Caches caches

operations

public final Operations operations

chats

public final Chats chats

files

public final Files files

async

public final Client.Async async

tunings

public final Tunings tunings

Constructor Details

Client

public Client()

Constructs a Client instance with environment variables.

Method Details

builder

public static Client.Builder builder()

Returns a Client.Builder for Client.

vertexAI

public boolean vertexAI()

Returns whether the client is using Vertex AI APIs.

project

public String project()

Returns the project ID for Vertex AI APIs.

location

public String location()

Returns the location for Vertex AI APIs.

apiKey

public String apiKey()

Returns the API key for Gemini API.

close

public void close()

Closes the Client instance together with its instantiated http client.

Specified by:

close in interface AutoCloseable

setDefaultBaseUrls

public static void setDefaultBaseUrls(Optional<String> geminiBaseUrl,
 Optional<String> vertexBaseUrl)

Overrides the base URLs for the Gemini API and/or Vertex AI API.

Note: This function should be called before initializing the SDK. If the base URLs are set after initializing the SDK, the base URLs will not be updated.

Precedence rule for base URL:

1. Base URL set via HttpOptions.

2. Base URL set via the latest call to setDefaultBaseUrls.

3. Base URL set via environment variables GOOGLE_GEMINI_BASE_URL or GOOGLE_VERTEX_BASE_URL.