FirebaseVertexAI
class FirebaseVertexAI
Entry point for all Vertex AI for Firebase functionality.
Summary
Public companion functions |
|
|---|---|
FirebaseVertexAI |
getInstance(app: FirebaseApp) |
FirebaseVertexAI |
getInstance(app: FirebaseApp, location: String)Returns the |
Public companion properties |
|
|---|---|
FirebaseVertexAI |
The |
Public functions |
|
|---|---|
GenerativeModel |
generativeModel(Instantiates a new |
Public companion functions
getInstance
fun getInstance(app: FirebaseApp = Firebase.app, location: String): FirebaseVertexAI
Returns the FirebaseVertexAI instance for the provided FirebaseApp and location
| Parameters | |
|---|---|
location: String |
location identifier, defaults to |
Public companion properties
Public functions
generativeModel
fun generativeModel(
modelName: String,
generationConfig: GenerationConfig? = null,
safetySettings: List<SafetySetting>? = null,
requestOptions: RequestOptions = RequestOptions(),
tools: List<Tool>? = null,
toolConfig: ToolConfig? = null,
systemInstruction: Content? = null
): GenerativeModel
Instantiates a new GenerativeModel given the provided parameters.
| Parameters | |
|---|---|
modelName: String |
name of the model in the backend |
generationConfig: GenerationConfig? = null |
configuration parameters to use for content generation |
safetySettings: List<SafetySetting>? = null |
safety bounds to use during alongside prompts during content generation |
requestOptions: RequestOptions = RequestOptions() |
configuration options to utilize during backend communication |
tools: List<Tool>? = null |
list of tools to make available to the model |
toolConfig: ToolConfig? = null |
configuration that defines how the model handles the tools provided |
systemInstruction: Content? = null |
contains a |