Optionalallowed_Allowed functions to call when the mode is "any". If empty, any one of the provided functions are called.
OptionalcachedUsed to specify a previously created context cache to use with generation. For Vertex, this should be of the form: "projects/PROJECT_NUMBER/locations/LOCATION/cachedContents/CACHE_ID",
See these guides for more information on how to use context caching: https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-create https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-use
OptionalconvertOptionalfrequencyFrequency 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.
OptionallabelsCustom 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"
}
}
OptionallogprobsWhether 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.
OptionalmaxMaximum number of tokens to generate in the completion. This may include reasoning tokens (for backwards compatibility).
OptionalmaxThe maximum number of the output tokens that will be used for the "thinking" or "reasoning" stages.
OptionalmodelModel to use
OptionalmodelModel to use
Alias for model
OptionalpresencePresence 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.
OptionalreasoningAn OpenAI compatible parameter that will map to "maxReasoningTokens"
OptionalresponseAvailable 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.OptionalresponseThe modalities of the response.
OptionalsafetyOptionalseedSeed used in decoding. If not set, the request uses a randomly generated seed.
OptionalspeechSpeech 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).
OptionalstopOptionalstreamingWhether or not to stream.
OptionaltemperatureSampling temperature to use
OptionalthinkingAn alias for "maxReasoningTokens"
Optionaltool_Force the model to use tools in a specific way.
| Mode | Description |
|---|---|
| "auto" | The default model behavior. The model decides whether to predict a function call or a natural language response. |
| "any" | The model must predict only function calls. To limit the model to a subset of functions, define the allowed function names in allowed_function_names. |
| "none" | The model must not predict function calls. This behavior is equivalent to a model request without any associated function declarations. |
| string | The string value must be one of the function names. This will force the model to predict the specified function call. |
The tool configuration's "any" mode ("forced function calling") is supported for Gemini 1.5 Pro models only.
OptionaltoolsOptionaltopKTop-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).
OptionaltopAn 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.
OptionaltopPTop-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).
The params which can be passed to the API at request time.