Firebase.AI.FirebaseAI

The entry point for all FirebaseAI SDK functionality.

Summary

Properties
DefaultInstance
static FirebaseAI
Returns a FirebaseAI instance with the default FirebaseApp and GoogleAI Backend.

Public static functions
GetInstance(Backend? backend, bool useLimitedUseAppCheckTokens)
Returns a FirebaseAI instance with the default FirebaseApp and the given Backend.
GetInstance(FirebaseApp app, Backend? backend, bool useLimitedUseAppCheckTokens)
Returns a FirebaseAI instance with the given FirebaseApp and Backend.

Public functions
GetGenerativeModel(string modelName, GenerationConfig? generationConfig, SafetySetting[] safetySettings, Tool[] tools, ToolConfig? toolConfig, ModelContent? systemInstruction, RequestOptions? requestOptions)
Initializes a generative model with the given parameters.
GetLiveModel(string modelName, LiveGenerationConfig? liveGenerationConfig, Tool[] tools, ModelContent? systemInstruction, RequestOptions? requestOptions)
Initializes a LiveGenerativeModel for real-time interaction.
GetTemplateGenerativeModel(RequestOptions? requestOptions)
Initializes a TemplateGenerativeModel with the given parameters.

Structs
Firebase.AI.FirebaseAI.Backend

Defines which backend AI service is being used, provided to FirebaseAI.GetInstance.

Properties

DefaultInstance

static FirebaseAI DefaultInstance

Returns a FirebaseAI instance with the default FirebaseApp and GoogleAI Backend.

Public static functions

GetInstance

FirebaseAI GetInstance(
  Backend? backend,
  bool useLimitedUseAppCheckTokens
)

Returns a FirebaseAI instance with the default FirebaseApp and the given Backend.

Details
Parameters
backend
The backend AI service to use.
useLimitedUseAppCheckTokens
Whether to use limited use App Check tokens for requests.
Returns
A configured instance of FirebaseAI.

GetInstance

FirebaseAI GetInstance(
  FirebaseApp app,
  Backend? backend,
  bool useLimitedUseAppCheckTokens
)

Returns a FirebaseAI instance with the given FirebaseApp and Backend.

Details
Parameters
app
The custom FirebaseApp used for initialization.
backend
The backend AI service to use.
useLimitedUseAppCheckTokens
Whether to use limited use App Check tokens for requests.
Returns
A configured instance of FirebaseAI.

Public functions

GetGenerativeModel

GenerativeModel GetGenerativeModel(
  string modelName,
  GenerationConfig? generationConfig,
  SafetySetting[] safetySettings,
  Tool[] tools,
  ToolConfig? toolConfig,
  ModelContent? systemInstruction,
  RequestOptions? requestOptions
)

Initializes a generative model with the given parameters.

  • Note: Refer to Gemini models for guidance on choosing an appropriate model for your use case.

Details
Parameters
modelName
The name of the model to use; see available model names for a list of supported model names.
generationConfig
The content generation parameters your model should use.
safetySettings
A value describing what types of harmful content your model should allow.
tools
A list of Tool objects that the model may use to generate the next response.
toolConfig
Tool configuration for any Tool specified in the request.
systemInstruction
Instructions that direct the model to behave a certain way; currently only text content is supported.
requestOptions
Configuration parameters for sending requests to the backend.
Returns
The initialized GenerativeModel instance.

GetLiveModel

LiveGenerativeModel GetLiveModel(
  string modelName,
  LiveGenerationConfig? liveGenerationConfig,
  Tool[] tools,
  ModelContent? systemInstruction,
  RequestOptions? requestOptions
)

Initializes a LiveGenerativeModel for real-time interaction.

  • Note: Refer to Gemini models for guidance on choosing an appropriate model for your use case.

Warning: This API is in Public Preview, which means that the feature is not subject to any SLA or deprecation policy and could change in backwards-incompatible ways.

Details
Parameters
modelName
The name of the model to use; see available model names for a list of supported model names.
liveGenerationConfig
The content generation parameters your model should use.
tools
A list of Tool objects that the model may use to generate the next response.
systemInstruction
Instructions that direct the model to behave a certain way.
requestOptions
Configuration parameters for sending requests to the backend.
Returns
The initialized LiveGenerativeModel instance.

GetTemplateGenerativeModel

TemplateGenerativeModel GetTemplateGenerativeModel(
  RequestOptions? requestOptions
)

Initializes a TemplateGenerativeModel with the given parameters.

Details
Parameters
requestOptions
Configuration parameters for sending requests to the backend.
Returns
The initialized TemplateGenerativeModel instance.