ChatFirebaseVertexAIOptions class

Options to pass into the Vertex AI for Firebase model.

You can find a list of available models here: https://firebase.google.com/docs/vertex-ai/gemini-models

Annotations

Constructors

ChatFirebaseVertexAIOptions.new({String? model, double? topP, int? topK, int? candidateCount, int? maxOutputTokens, double? temperature, List<String>? stopSequences, String? responseMimeType, Map<String, dynamic>? responseSchema, List<ChatFirebaseVertexAISafetySetting>? safetySettings, List<ToolSpec>? tools, ChatToolChoice? toolChoice, int concurrencyLimit = 1000})
Options to pass into the Vertex AI for Firebase model.
const

Properties

candidateCount → int?
Number of generated responses to return. This value must be between 1, 8, inclusive. If unset, this will default to 1.
final
concurrencyLimit → int
The maximum number of concurrent calls that the runnable can make. Defaults to 1000 (different Runnable types may have different defaults).
finalinherited
hashCode → int
The hash code for this object.
no setter
maxOutputTokens → int?
The maximum number of tokens to include in a candidate. If unset, this will default to output_token_limit specified in the Model specification.
final
model → String?
ID of the language model to use. Check the provider's documentation for available models.
finalinherited
responseMimeType → String?
Output response mimetype of the generated candidate text.
final
responseSchema → Map<String, dynamic>?
Output response schema of the generated candidate text. Following the JSON Schema specification.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
safetySettings → List<ChatFirebaseVertexAISafetySetting>?
A list of unique ChatFirebaseVertexAISafetySetting instances for blocking unsafe content.
final
stopSequences → List<String>?
The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a stop sequence. The stop sequence will not be included as part of the response.
final
temperature → double?
Controls the randomness of the output.
final
toolChoice → ChatToolChoice?
Controls which (if any) tool is called by the model.
finalinherited
tools → List<ToolSpec>?
A list of tools the model may call.
finalinherited
topK → int?
The maximum number of tokens to consider when sampling. The model uses combined Top-k and nucleus sampling. Top-k sampling considers the set of top_k most probable tokens. Defaults to 40. Note:
final
topP → double?
The maximum cumulative probability of tokens to consider when sampling. The model uses combined Top-k and nucleus sampling. Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits number of tokens based on the cumulative probability.
final

Methods

copyWith({String? model, double? topP, int? topK, int? candidateCount, int? maxOutputTokens, double? temperature, List<String>? stopSequences, String? responseMimeType, List<ChatFirebaseVertexAISafetySetting>? safetySettings, List<ToolSpec>? tools, ChatToolChoice? toolChoice, int? concurrencyLimit}) → ChatFirebaseVertexAIOptions
Creates a copy of this RunnableOptions with the given fields replaced by the new values.
merge(covariant ChatFirebaseVertexAIOptions? other) → ChatFirebaseVertexAIOptions
Merges this RunnableOptions with another RunnableOptions.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(covariant ChatFirebaseVertexAIOptions other) → bool
The equality operator.