FirebaseVertexAI
public final class FirebaseVertexAI
Entry point for all Vertex AI in Firebase functionality.
Summary
Nested types |
|---|
public static class FirebaseVertexAI.Companion |
Public fields |
|
|---|---|
static final @NonNull FirebaseVertexAI |
The |
Public fields
instance
public static final @NonNull FirebaseVertexAI instance
The FirebaseVertexAI instance for the default FirebaseApp
Public methods
generativeModel
public final @NonNull GenerativeModel generativeModel(
@NonNull String modelName,
GenerationConfig generationConfig,
List<@NonNull SafetySetting> safetySettings,
List<@NonNull Tool> tools,
ToolConfig toolConfig,
Content systemInstruction,
@NonNull RequestOptions requestOptions
)
Instantiates a new GenerativeModel given the provided parameters.
| Parameters | |
|---|---|
@NonNull String modelName |
The name of the model to use, for example |
GenerationConfig generationConfig |
The configuration parameters to use for content generation. |
List<@NonNull SafetySetting> safetySettings |
The safety bounds the model will abide to during content generation. |
List<@NonNull Tool> tools |
A list of |
ToolConfig toolConfig |
The |
Content systemInstruction |
|
@NonNull RequestOptions requestOptions |
Configuration options for sending requests to the backend. |
| Returns | |
|---|---|
@NonNull GenerativeModel |
The initialized |
getInstance
public static final @NonNull FirebaseVertexAI getInstance(@NonNull FirebaseApp app, @NonNull String location)
Returns the FirebaseVertexAI instance for the provided FirebaseApp and location.
| Parameters | |
|---|---|
@NonNull String location |
location identifier, defaults to |
imagenModel
@PublicPreviewAPI
public final @NonNull ImagenModel imagenModel(
@NonNull String modelName,
ImagenGenerationConfig generationConfig,
ImagenSafetySettings safetySettings,
@NonNull RequestOptions requestOptions
)
Instantiates a new ImagenModel given the provided parameters.
| Parameters | |
|---|---|
@NonNull String modelName |
The name of the model to use, for example |
ImagenGenerationConfig generationConfig |
The configuration parameters to use for image generation. |
ImagenSafetySettings safetySettings |
The safety bounds the model will abide by during image generation. |
@NonNull RequestOptions requestOptions |
Configuration options for sending requests to the backend. |
| Returns | |
|---|---|
@NonNull ImagenModel |
The initialized |
liveModel
@PublicPreviewAPI
public final @NonNull LiveGenerativeModel liveModel(
@NonNull String modelName,
LiveGenerationConfig generationConfig,
List<@NonNull Tool> tools,
Content systemInstruction,
@NonNull RequestOptions requestOptions
)
Instantiates a new LiveGenerationConfig given the provided parameters.
| Parameters | |
|---|---|
@NonNull String modelName |
The name of the model to use, for example |
LiveGenerationConfig generationConfig |
The configuration parameters to use for content generation. |
List<@NonNull Tool> tools |
A list of |
Content systemInstruction |
|
@NonNull RequestOptions requestOptions |
Configuration options for sending requests to the backend. |
| Returns | |
|---|---|
@NonNull LiveGenerativeModel |
The initialized |