com.google.firebase.vertexai.type

Interfaces

Part

Interface representing data sent to and received from requests.

Classes

BlobPart

Represents binary data with an associated MIME type sent to and received from requests.

Candidate

A response generated by the model.

CitationMetadata

Provides citation metadata for sourcing of content provided by the model between a given startIndex and endIndex.

Content

Represents content sent to and received from the model.

Content.Builder

Builder class to facilitate constructing complex Content objects.

ContentKt
CountTokensResponse

Represents a response measuring model input.

FileDataPart

Represents file data stored in Cloud Storage for Firebase, referenced by URI.

FourParameterFunction

A declared four param function, including implementation, that a model can be given access to in order to gain info or complete tasks.

FunctionCallPart

Represents function call name and params received from requests.

FunctionCallingConfig

Contains configuration for function calling from the model.

FunctionDeclaration

A declared function, including implementation, that a model can be given access to in order to gain info or complete tasks.

FunctionDeclarationsKt
FunctionParameter
FunctionResponsePart

Represents function call output to be returned to the model when it requests a function call.

FunctionType

Represents and passes the type information for an automated function call.

GenerateContentResponse

Represents a response from the model.

GenerationConfig

Configuration parameters to use for content generation.

GenerationConfig.Builder

Builder for creating a GenerationConfig.

GenerationConfigKt
ImagePart

Represents image data sent to and received from requests.

NoParameterFunction

A declared zero param function, including implementation, that a model can be given access to in order to gain info or complete tasks.

OneParameterFunction

A declared one param function, including implementation, that a model can be given access to in order to gain info or complete tasks.

PartKt
PromptFeedback

Feedback on the prompt provided in the request.

RequestOptions

Configurable options unique to how requests to the backend are performed.

SafetyRating

Safety rating corresponding to a generated content.

SafetySetting

A configuration for a BlockThreshold of some HarmCategory allowed and blocked in responses.

Schema

Represents a parameter for a declared function

TextPart

Represents text or string based data sent to and received from requests.

ThreeParameterFunction

A declared three param function, including implementation, that a model can be given access to in order to gain info or complete tasks.

Tool

Contains a set of function declarations that the model has access to.

ToolConfig

Contains configuration for the function calling tools of the model.

TwoParameterFunction

A declared two param function, including implementation, that a model can be given access to in order to gain info or complete tasks.

UsageMetadata

Usage metadata about response(s).

Enums

BlockReason

Describes why content was blocked.

BlockThreshold

Represents the threshold for some HarmCategory that is allowed and blocked by SafetySetting.

FinishReason

The reason for content finishing.

FunctionCallingConfig.Mode

Configuration for dictating when the model should call the attached function.

HarmCategory

Category for a given harm rating.

HarmProbability

Represents the probability that some HarmCategory is applicable in a SafetyRating.

HarmSeverity

Represents the severity of a HarmCategory being applicable in a SafetyRating.

Exceptions

FirebaseVertexAIException

Parent class for any errors that occur from the FirebaseVertexAI SDK.

InvalidAPIKeyException

The server responded that the API Key is not valid.

InvalidLocationException

The specified Vertex AI location is invalid.

InvalidStateException

Some form of state occurred that shouldn't have.

PromptBlockedException

A request was blocked for some reason.

RequestTimeoutException

A request took too long to complete.

ResponseStoppedException

A request was stopped during generation for some reason.

SerializationException

Something went wrong while trying to deserialize a response from the server.

ServerException

The server responded with a non 200 response code.

ServiceDisabledException

The service is not enabled for this project.

UnknownException

Catch all case for exceptions not explicitly expected.

UnsupportedUserLocationException

The user's location (region) is not supported by the API.