Class Client (1.118.0) 

Client(
    *,
    api_key: typing.Optional[str] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    project: typing.Optional[str] = None,
    location: typing.Optional[str] = None,
    debug_config: typing.Optional[google.genai.client.DebugConfig] = None,
    http_options: typing.Optional[
        typing.Union[google.genai.types.HttpOptions, google.genai.types.HttpOptionsDict]
    ] = None
)

Gen AI Client for the Vertex SDK.

Use this client to interact with Vertex-specific Gemini features.

Properties

agent_engines

API documentation for agent_engines property.

aio

API documentation for aio property.

evals

API documentation for evals property.

prompt_optimizer

API documentation for prompt_optimizer property.

prompts

API documentation for prompts property.

Methods

Client

Client(
    *,
    api_key: typing.Optional[str] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    project: typing.Optional[str] = None,
    location: typing.Optional[str] = None,
    debug_config: typing.Optional[google.genai.client.DebugConfig] = None,
    http_options: typing.Optional[
        typing.Union[google.genai.types.HttpOptions, google.genai.types.HttpOptionsDict]
    ] = None
)

Initializes the client.

Parameters
Name Description
api_key str

The `API key
credentials google.auth.credentials.Credentials

The credentials to use for authentication when calling the Vertex AI APIs. Credentials can be obtained from environment variables and default credentials. For more information, see Set up Application Default Credentials https://cloud.google.com/docs/authentication/provide-credentials-adc_.
project str

The Google Cloud project ID https://cloud.google.com/vertex-ai/docs/start/cloud-environment_ to use for quota. Can be obtained from environment variables (for example, GOOGLE_CLOUD_PROJECT).
location str

The location https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations_ to send API requests to (for example, us-central1). Can be obtained from environment variables.
debug_config DebugConfig

Config settings that control network behavior of the client. This is typically used when running test code.
http_options Union[HttpOptions, HttpOptionsDict]

Http options to use for the client.