Documentation

google.VertexClient$stream

Gemini on Vertex AI: the same models as `google.GeminiClient`, reached through a Google Cloud project with Google Cloud credentials.

Reference version

Signature

class google.VertexClient$stream

Gemini on Vertex AI: the same models as google.GeminiClient, reached through a Google Cloud project with Google Cloud credentials.

Three ways to authenticate, in the order the client tries them:

  • credentials_json — an inline credential document (service account, authorized user, workload identity federation, impersonated service account);
  • credentials_file — a path to one, plus the GOOGLE_APPLICATION_CREDENTIALS_CONTENT env var holding a document inline;
  • nothing — Application Default Credentials (GOOGLE_APPLICATION_CREDENTIALS, the well-known ADC file, the gcloud config file, the GCE metadata server).

api_key selects Vertex AI express mode instead: the key rides the URL as ?key=…, no credentials are read, and the request goes to the project-less global endpoint unless a project is configured.

Source:<builtin>/google/vertex.bamlbytes 0–0

Fields

model

string | null

project_id

ai.Credential$stream | null

location

string | null

credentials_json

string | null

credentials_file

string | null

api_key

ai.Credential$stream | null

base_url

ai.Credential$stream | null

request_timeout_ms

int | null

time_to_first_token_timeout_ms

int | null

request_body

baml.json.json$stream | null

headers

map<string, string> | null

query_params

map<string, string> | null

temperature

float | null

max_output_tokens

int | null

top_p

float | null

top_k

int | null

stop_sequences

string[] | null

response_modalities

string[] | null

capture_wire

bool | null