Interface ChatGoogleBaseInput<AuthOptions>

Some APIs allow an API key instead

The version of the API functions. Part of the path.

Deprecated

Use callbacks instead

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

• If true, will always bypass streaming case.
• If false (default), will always use streaming case if available.

Hostname for the API call (if this is running on GCP)

Frequency penalty applied to the next token's logprobs, multiplied by the number of times each token has been seen in the respponse so far. A positive penalty will discourage the use of tokens that have already been used, proportional to the number of times the token has been used: The more a token is used, the more dificult it is for the model to use that token again increasing the vocabulary of responses. Caution: A negative penalty will encourage the model to reuse tokens proportional to the number of times the token has been used. Small negative values will reduce the vocabulary of a response. Larger negative values will cause the model to start repeating a common token until it hits the maxOutputTokens limit.

Custom metadata labels to associate with the request. Only supported on Vertex AI (Google Cloud Platform). Labels are key-value pairs where both keys and values must be strings.

Example:

{
  labels: {
    "team": "research",
    "component": "frontend",
    "environment": "production"
  }
}
Copy

Region where the LLM is stored (if this is running on GCP)

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

Maximum number of tokens to generate in the completion. This may include reasoning tokens (for backwards compatibility).

The maximum number of the output tokens that will be used for the "thinking" or "reasoning" stages.

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Model to use

Model to use Alias for model

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

What platform to run the service on. If not specified, the class should determine this from other means. Either way, the platform actually used will be in the "platform" getter.

Presence penalty applied to the next token's logprobs if the token has already been seen in the response. This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequencyPenalty for a penalty that increases with each use. A positive penalty will discourage the use of tokens that have already been used in the response, increasing the vocabulary. A negative penalty will encourage the use of tokens that have already been used in the response, decreasing the vocabulary.

An OpenAI compatible parameter that will map to "maxReasoningTokens"

Available for gemini-1.5-pro. The output format of the generated candidate text. Supported MIME types:

• text/plain: Text output.
• application/json: JSON response in the candidates.

Default

"text/plain"
Copy

The modalities of the response.

Seed used in decoding. If not set, the request uses a randomly generated seed.

Speech generation configuration. You can use either Google's definition of the speech configuration, or a simplified version we've defined (which can be as simple as the name of a pre-defined voice).

Whether or not to include usage data, like token counts in the streamed response chunks.

Default

true
Copy

Whether or not to stream.

Default

false
Copy

Sampling temperature to use

An alias for "maxReasoningTokens"

Top-k changes how the model selects tokens for output.

A top-k of 1 means the selected token is the most probable among all tokens in the model’s vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature).

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

Top-p changes how the model selects tokens for output.

Tokens are selected from most probable to least until the sum of their probabilities equals the top-p value.

For example, if tokens A, B, and C have a probability of .3, .2, and .1 and the top-p value is .5, then the model will select either A or B as the next token (using temperature).

For compatibility with Google's libraries, should this use Vertex? The "platformType" parmeter takes precedence.