firebase_vertexai library

Classes

Candidate
Response candidate generated from a GenerativeModel.
ChatSession
A back-and-forth chat with a generative model.
Citation
Citation to a source for a portion of a specific response.
CitationMetadata
Source attributions for a piece of content.
Content
The base structured datatype containing multi-part content of a message.
CountTokensResponse
Response for Count Tokens
FileData
A Part with Firebase Storage uri as prompt content
FirebaseVertexAI
The entrypoint for FirebaseVertexAI.
FunctionCall
A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name with the arguments and their values.
FunctionCallingConfig
Configuration specifying how the model should use the functions provided as tools.
FunctionDeclaration
Structured representation of a function declaration as defined by the OpenAPI 3.03 specification.
FunctionResponse
The response class for FunctionCall
GenerateContentResponse
Response from the model; supports multiple candidates.
GenerationConfig
Configuration options for model generation and outputs.
GenerativeModel
A multimodel generative model (like Gemini).
ImagenFormat
Represents the image format and compression quality.
ImagenGenerationConfig
Configuration options for image generation.
ImagenInlineImage
Represents an image stored as a base64-encoded string.
ImagenModel
Represents a remote Imagen model with the ability to generate images using text prompts.
ImagenSafetySettings
A class representing safety settings for image generation.
InlineDataPart
A Part with the byte content of a file.
LiveGenerationConfig
Configures live generation settings.
LiveGenerativeModel
A live, generative AI model for real-time interaction.
LiveServerContent
Content generated by the model in a live stream.
LiveServerMessage
An abstract class representing a message received from a live server.
LiveServerResponse
A single response chunk received during a live content generation.
LiveServerToolCall
A tool call in a live stream.
LiveServerToolCallCancellation
A tool call cancellation in a live stream.
LiveSession
Manages asynchronous communication with Gemini model over a WebSocket connection.
Part
A datatype containing media that is part of a multi-part Content message.
PromptFeedback
Feedback metadata of a prompt specified in a GenerativeModel request.
SafetyRating
Safety rating for a piece of content.
SafetySetting
Safety setting, affecting the safety-blocking behavior.
Schema
The definition of an input or output data types.
SpeechConfig
Configures speech synthesis settings.
TextPart
A Part with the text content.
Tool
Tool details that the model may use to generate a response.
ToolConfig
Config for tools to use with model.
UsageMetadata
Metadata on the generation request's token usage.

Enums

BlockReason
The reason why a prompt was blocked.
FinishReason
Reason why a model stopped generating tokens.
FunctionCallingMode
The mode in which the model should use the functions provided as tools.
HarmBlockMethod
Specifies how the block method computes the score that will be compared against the HarmBlockThreshold in SafetySetting.
HarmBlockThreshold
Probability of harm which causes content to be blocked.
HarmCategory
The category of a rating.
HarmProbability
The probability that a piece of content is harmful.
ImagenAspectRatio
The aspect ratio for the image.
ImagenPersonFilterLevel
Allow generation of people by the model.
ImagenSafetyFilterLevel
Specifies the level of safety filtering for image generation.
ResponseModalities
The available response modalities.
SchemaType
The value type of a Schema.

Typedefs

VertexAIException = FirebaseAIException
Exception thrown when generating content fails.
VertexAISdkException = FirebaseAISdkException
Exception indicating a stale package version or implementation bug.

Exceptions / Errors

InvalidApiKey
Exception thrown when the server rejects the API key.
ServerException
Exception thrown when the server failed to generate content.
UnsupportedUserLocation
Exception thrown when the user location is unsupported.