Firebase AI Logic Flutter

https://pub.dev/documentation/firebase_ai/latest/
Admin
A Flutter plugin that provides access to Firebase's generative AI models like Gemini and Imagen for...
Tokens:99,269
Snippets:1,060
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initiating a ChatSession

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartChatExtension/startChat.html

Demonstrates how to start a chat session and send a message to the model.

```dart
final chat = model.startChat();
final response = await chat.sendMessage(Content.text('Hello there.'));
print(response.text);
```

--------------------------------

### startChat(history, safetySettings, generationConfig, maxTurns)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartChatExtension/startChat.html

Starts a ChatSession that will use the model to respond to messages.

```APIDOC
## startChat

### Description
Starts a ChatSession that will use this model to respond to messages.

### Signature
ChatSession startChat({List<Content>? history, List<SafetySetting>? safetySettings, GenerationConfig? generationConfig, int? maxTurns})

### Parameters
- **history** (List<Content>?) - Optional - A list of previous messages to initialize the chat session.
- **safetySettings** (List<SafetySetting>?) - Optional - Configuration for safety filters.
- **generationConfig** (GenerationConfig?) - Optional - Configuration for the generation process.
- **maxTurns** (int?) - Optional - The maximum number of turns allowed in the chat session.

### Example
```dart
final chat = model.startChat();
final response = await chat.sendMessage(Content.text('Hello there.'));
print(response.text);
```
```

--------------------------------

### Initialize and use a TemplateChatSession

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartTemplateChatExtension/startChat.html

Demonstrates how to start a chat session with a template ID and inputs, then send a message.

```dart
final chat = model.startChat('my_template', inputs: {'language': 'en'});
final response = await chat.sendMessage(Content.text('Hello there.'));
print(response.text);
```

--------------------------------

### StartChatExtension

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai

An extension on GenerativeModel that enables starting a chat session.

```APIDOC
## StartChatExtension

### Description
An extension on GenerativeModel that provides functionality to initiate a chat session.
```

--------------------------------

### startChat Method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartTemplateChatExtension.html

Starts a TemplateChatSession that uses the model to respond to messages.

```APIDOC
## startChat

### Description
Starts a TemplateChatSession that will use this model to respond to messages.

### Parameters
- **templateId** (String) - Required - The ID of the template to use.
- **inputs** (Map<String, Object?>) - Required - Input values for the template.
- **history** (List<Content>) - Optional - Previous chat history.
- **tools** (List<TemplateTool>) - Optional - Tools available to the model.
- **toolConfig** (TemplateToolConfig) - Optional - Configuration for the tools.
- **maxTurns** (int) - Optional - Maximum number of turns for the session.

### Returns
- **TemplateChatSession** - A new session instance.
```

--------------------------------

### Streaming content generation example

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GenerativeModel/generateContentStream.html

Demonstrates how to iterate over a stream of responses generated from a text prompt.

```dart
final responses = await model.generateContent([Content.text(prompt)]);
await for (final response in responses) {
  print(response.text);
}
```

--------------------------------

### startChat

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GenerativeModel-class.html

Starts a chat session using the current model.

```APIDOC
## startChat

### Description
Starts a ChatSession that will use this model to respond to messages.

### Parameters
- **history** (List<Content>) - Optional - Initial chat history.
- **safetySettings** (List<SafetySetting>) - Optional - Safety settings for the chat.
- **generationConfig** (GenerationConfig) - Optional - Configuration for generation.
- **maxTurns** (int) - Optional - Maximum number of turns in the chat.

### Response
- **ChatSession** - The initialized chat session.
```

--------------------------------

### SpeechConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeechConfig/SpeechConfig.html

Initializes a new instance of SpeechConfig for a single-speaker setup.

```APIDOC
## SpeechConfig constructor

### Description
Constructs a SpeechConfig for a single-speaker setup.

### Signature
SpeechConfig({String? voiceName, String? languageCode})

### Parameters
- **voiceName** (String?) - Optional - The name of the voice to be used.
- **languageCode** (String?) - Optional - The BCP-47 language code for the speech configuration.
```

--------------------------------

### sendMediaStream()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveSession-class.html

Starts streaming media chunks to the server from the provided mediaChunkStream.

```APIDOC
## sendMediaStream()

### Description
Starts streaming media chunks to the server from the provided mediaChunkStream.

### Parameters
- **mediaChunkStream** (Stream<InlineDataPart>) - Required - The stream of media chunks.

### Signature
`Future<void> sendMediaStream(Stream<InlineDataPart> mediaChunkStream)`
```

--------------------------------

### SpeechConfig(String? voiceName, String? languageCode)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeechConfig-class.html

Constructs a SpeechConfig instance for a single-speaker setup.

```APIDOC
## SpeechConfig(String? voiceName, String? languageCode)

### Description
Constructs a SpeechConfig for a single-speaker setup.

### Parameters
- **voiceName** (String?) - Optional - The voice name to use for a single-speaker setup.
- **languageCode** (String?) - Optional - The optional IETF BCP-47 language code.
```

--------------------------------

### Future<LiveSession> connect({SessionResumptionConfig? sessionResumption})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveGenerativeModel/connect.html

Establishes a connection to a live generation service. This function handles the WebSocket connection setup and returns a LiveSession object.

```APIDOC
## connect

### Description
Establishes a connection to a live generation service. This function handles the WebSocket connection setup and returns a LiveSession object that can be used to communicate with the service.

### Signature
`Future<LiveSession> connect({SessionResumptionConfig? sessionResumption})`

### Parameters
- **sessionResumption** (SessionResumptionConfig?) - Optional - The configuration for session resumption, such as the handle to the previous session state to restore.

### Returns
- **Future<LiveSession>** - A Future that resolves to a LiveSession object upon successful connection.
```

--------------------------------

### Content.system(String instructions)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/system.html

Creates a Content object with a 'system' role and a TextPart containing the provided instructions.

```APIDOC
## Content.system(String instructions)

### Description
Creates a new Content object initialized with a 'system' role and a single TextPart containing the specified instructions. This is typically used to set the behavioral context for an AI model.

### Parameters
- **instructions** (String) - Required - The system instruction text to be assigned to the Content object.

### Returns
- **Content** - A Content object configured with the 'system' role and the provided text.
```

--------------------------------

### SpeechConfig.multiSpeaker

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeechConfig/SpeechConfig.multiSpeaker.html

Constructs a SpeechConfig instance specifically for multi-speaker setups.

```APIDOC
## SpeechConfig.multiSpeaker

### Description
Constructs a SpeechConfig for a multi-speaker setup.

### Signature
SpeechConfig.multiSpeaker({required MultiSpeakerVoiceConfig? multiSpeakerVoiceConfig, String? languageCode})

### Parameters
- **multiSpeakerVoiceConfig** (MultiSpeakerVoiceConfig) - Required - The configuration for the multi-speaker voice.
- **languageCode** (String) - Optional - The language code for the speech configuration.
```

--------------------------------

### Create system instructions with system static method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/system.html

Use this method to initialize a Content object with a 'system' role and the provided instruction string.

```dart
content_copystatic Content system(String instructions) =>
    Content('system', [TextPart(instructions)]);
```

--------------------------------

### ContextWindowCompressionConfig()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ContextWindowCompressionConfig/ContextWindowCompressionConfig.html

Creates a new instance of ContextWindowCompressionConfig with optional token trigger and sliding window parameters.

```APIDOC
## ContextWindowCompressionConfig()

### Description
Creates a new instance of the ContextWindowCompressionConfig class to manage context window compression settings.

### Parameters
- **triggerTokens** (int?) - Optional - The number of tokens that triggers the compression mechanism.
- **slidingWindow** (SlidingWindow?) - Optional - The sliding window compression mechanism to use.
```

--------------------------------

### startChat Method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartChatExtension.html

Initializes a new ChatSession using the GenerativeModel to handle multi-turn conversations.

```APIDOC
## startChat

### Description
Starts a ChatSession that will use this model to respond to messages.

### Method
Extension Method

### Parameters
#### Optional Parameters
- **history** (List<Content>) - Optional - A list of previous messages to initialize the chat session.
- **safetySettings** (List<SafetySetting>) - Optional - Configuration for safety filters.
- **generationConfig** (GenerationConfig) - Optional - Configuration for the generation process.
- **maxTurns** (int) - Optional - The maximum number of turns allowed in the chat session.

### Response
- **ChatSession** - Returns a new ChatSession instance.
```

--------------------------------

### WebGroundingChunk constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/WebGroundingChunk/WebGroundingChunk.html

Initializes a new instance of WebGroundingChunk with optional metadata.

```APIDOC
## WebGroundingChunk constructor

### Description
Creates a new instance of the WebGroundingChunk class to represent a grounding source.

### Signature
WebGroundingChunk({String? uri, String? title, String? domain})

### Parameters
- **uri** (String?) - Optional - The URI associated with the grounding chunk.
- **title** (String?) - Optional - The title of the grounding chunk.
- **domain** (String?) - Optional - The domain associated with the grounding chunk.
```

--------------------------------

### liveGenerativeModel(model, liveGenerationConfig, tools, systemInstruction)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/FirebaseAI/liveGenerativeModel.html

Creates a LiveGenerativeModel instance for real-time interaction.

```APIDOC
## liveGenerativeModel

### Description
Creates a LiveGenerativeModel for real-time interaction.

### Signature
`LiveGenerativeModel liveGenerativeModel({required String model, LiveGenerationConfig? liveGenerationConfig, List<Tool>? tools, Content? systemInstruction})`

### Parameters
- **model** (String) - Required - The name of the model to use.
- **liveGenerationConfig** (LiveGenerationConfig) - Optional - Configuration to control and guide the generation.
- **tools** (List<Tool>) - Optional - A list of tools available to the model.
- **systemInstruction** (Content) - Optional - System instructions for the model.

### Returns
- **LiveGenerativeModel** - An instance configured for real-time interaction.
```

--------------------------------

### Get properties for SchemaType.object

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/JSONSchema/properties.html

Retrieves the properties map for the schema object.

```dart
@override
Map<String, JSONSchema>? get properties =>
    super.properties as Map<String, JSONSchema>?;
```

--------------------------------

### Initialize ContextWindowCompressionConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ContextWindowCompressionConfig/ContextWindowCompressionConfig.html

Creates a new instance of the configuration class with optional trigger tokens and sliding window settings.

```dart
ContextWindowCompressionConfig({this.triggerTokens, this.slidingWindow});
```

--------------------------------

### Get items property

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/JSONSchema/items.html

Retrieves the JSONSchema for elements if the type is an array.

```dart
@override
JSONSchema? get items => super.items as JSONSchema?;
```

--------------------------------

### Initialize ImagenStyleConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenStyleConfig/ImagenStyleConfig.html

Use this constructor to create a new instance of ImagenStyleConfig with an optional description.

```dart
ImagenStyleConfig({
  this.description,
});
```

--------------------------------

### SpeechConfig.multiSpeaker(MultiSpeakerVoiceConfig? multiSpeakerVoiceConfig, String? languageCode)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeechConfig-class.html

Constructs a SpeechConfig instance for a multi-speaker setup.

```APIDOC
## SpeechConfig.multiSpeaker(MultiSpeakerVoiceConfig? multiSpeakerVoiceConfig, String? languageCode)

### Description
Constructs a SpeechConfig for a multi-speaker setup.

### Parameters
- **multiSpeakerVoiceConfig** (MultiSpeakerVoiceConfig?) - Required - The multi-speaker configuration.
- **languageCode** (String?) - Optional - The optional IETF BCP-47 language code.
```

--------------------------------

### LiveGenerationConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveGenerationConfig/LiveGenerationConfig.html

Initializes a new instance of LiveGenerationConfig with optional parameters for speech, audio transcription, context window, and model behavior.

```APIDOC
## LiveGenerationConfig constructor

### Description
Initializes a new configuration object for live generation, allowing customization of audio processing, context management, and model output parameters.

### Signature
LiveGenerationConfig({
  SpeechConfig? speechConfig,
  AudioTranscriptionConfig? inputAudioTranscription,
  AudioTranscriptionConfig? outputAudioTranscription,
  ContextWindowCompressionConfig? contextWindowCompression,
  List<ResponseModalities>? responseModalities,
  int? maxOutputTokens,
  double? temperature,
  double? topP,
  int? topK,
  double? presencePenalty,
  double? frequencyPenalty,
  MediaResolution? mediaResolution
})
```

--------------------------------

### GET /values

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenSubjectReferenceType/values-constant.html

Retrieves the constant list of all values defined within the ImagenSubjectReferenceType enum.

```APIDOC
## GET /values

### Description
Returns a constant List of the values in the ImagenSubjectReferenceType enum, ordered by their declaration.

### Method
GET

### Endpoint
/values

### Response
#### Success Response (200)
- **values** (List<ImagenSubjectReferenceType>) - A list containing all enum members.
```

--------------------------------

### connect

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveGenerativeModel-class.html

Establishes a connection to a live generation service.

```APIDOC
## Future<LiveSession> connect({SessionResumptionConfig? sessionResumption})

### Description
Establishes a connection to a live generation service for real-time interaction.

### Parameters
- **sessionResumption** (SessionResumptionConfig) - Optional - Configuration for resuming a previous session.

### Returns
- **Future<LiveSession>** - A future that completes with a LiveSession object representing the active connection.
```

--------------------------------

### Define anyOf schema

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/JSONSchema/anyOf.html

Example of using anyOf to allow a value to be either a String or an Integer.

```dart
Schema.anyOf(schemas: [Schema.string(), Schema.integer()]);
```

--------------------------------

### Implement urlContext static method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Tool/urlContext.html

This method returns a Tool configured with the provided UrlContext. It is currently in Public Preview and subject to change.

```dart
static Tool urlContext({UrlContext urlContext = const UrlContext()}) {
  return Tool._(null, null, null, urlContext, null);
}
```

--------------------------------

### ContextWindowCompressionConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ContextWindowCompressionConfig-class.html

Creates a new instance of the ContextWindowCompressionConfig to manage context window limits.

```APIDOC
## ContextWindowCompressionConfig({int? triggerTokens, SlidingWindow? slidingWindow})

### Description
Creates a ContextWindowCompressionConfig instance to manage the model's context window.

### Parameters
- **triggerTokens** (int?) - Optional - The number of tokens that triggers the context window compression.
- **slidingWindow** (SlidingWindow?) - Optional - The sliding window compression mechanism to be used.
```

--------------------------------

### MultiSpeakerVoiceConfig()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/MultiSpeakerVoiceConfig/MultiSpeakerVoiceConfig.html

Initializes a new instance of MultiSpeakerVoiceConfig with the required speaker voice configurations.

```APIDOC
## MultiSpeakerVoiceConfig()

### Description
Creates a new instance of the MultiSpeakerVoiceConfig class to define voice settings for multiple speakers.

### Parameters
- **speakerVoiceConfigs** (List<SpeakerVoiceConfig>) - Required - A list of configurations defining the voice settings for each speaker.
```

--------------------------------

### resumeSession Implementation

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveSession/resumeSession.html

This method cancels the existing WebSocket subscription, closes the sink, and performs a new WebSocket setup.

```dart
Future<void> resumeSession(
    {SessionResumptionConfig? sessionResumption}) async {
  try {
    await _wsSubscription.cancel().timeout(const Duration(seconds: 2),
        onTimeout: () {
      log('live_session.resumeSession: WebSocket subscription cancel timed out.',
          error: TimeoutException('Cancel timed out'));
    });
    await _ws.sink.close().timeout(const Duration(seconds: 2), onTimeout: () {
      log('live_session.resumeSession: WebSocket close timed out.',
          error: TimeoutException('Close timed out'));
    });

    _ws = await _performWebSocketSetup(
      uri: _uri,
      headers: _headers,
      modelString: _modelString,
      systemInstruction: _systemInstruction,
      tools: _tools,
      sessionResumption: sessionResumption,
      liveGenerationConfig: _liveGenerationConfig,
    );
  } catch (e) {
    log('live_session.resumeSession: WebSocket setup failed', error: e);
    rethrow;
  }

  _listenToWebSocket();
}
```

--------------------------------

### ExecutableCodePart constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ExecutableCodePart/ExecutableCodePart.html

Initializes a new instance of ExecutableCodePart with the specified language and code content.

```APIDOC
## ExecutableCodePart constructor

### Description
Creates a new instance of ExecutableCodePart to represent a code snippet in the AI response.

### Signature
ExecutableCodePart({required CodeLanguage language, required String code, bool? isThought})

### Parameters
- **language** (CodeLanguage) - Required - The programming language of the code snippet.
- **code** (String) - Required - The actual source code string.
- **isThought** (bool?) - Optional - Indicates if this part is considered a thought process.
```

--------------------------------

### Initialize UrlContext

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/UrlContext/UrlContext.html

Use the const constructor to create a new instance of UrlContext.

```dart
const UrlContext();
```

--------------------------------

### Get BlockReason Enum Values

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/BlockReason.html

Provides a constant list of all available BlockReason enum values in their declaration order.

```dart
const List<BlockReason> values
```

--------------------------------

### Future<void> sendMediaStream(Stream<InlineDataPart> mediaChunkStream)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveSession/sendMediaStream.html

Starts streaming media chunks to the server from the provided mediaChunkStream. This method is deprecated.

```APIDOC
## sendMediaStream

### Description
Starts streaming media chunks to the server from the provided `mediaChunkStream`. This function asynchronously processes each `InlineDataPart` from the given stream and sends it to the server via the WebSocket connection.

### Signature
`Future<void> sendMediaStream(Stream<InlineDataPart> mediaChunkStream)`

### Parameters
- **mediaChunkStream** (Stream<InlineDataPart>) - Required - The stream of InlineDataPart objects to send to the server.

### Note
This method is @Deprecated. Use `sendAudio`, `sendVideo`, or `sendText` with a stream instead.
```

--------------------------------

### Implement googleSearch static method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Tool/googleSearch.html

This method returns a Tool configured to enable Google Search grounding. It requires an instance of GoogleSearch.

```dart
static Tool googleSearch({GoogleSearch googleSearch = const GoogleSearch()}) {
  return Tool._(null, googleSearch, null, null, null);
}
```

--------------------------------

### Initialize Content instance

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/Content.html

Use this constructor to create a Content object by providing a role and a list of parts.

```dart
Content(this.role, this.parts);
```

--------------------------------

### Initialize MultiSpeakerVoiceConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/MultiSpeakerVoiceConfig/MultiSpeakerVoiceConfig.html

Use this constructor to define the voice configurations for multiple speakers.

```dart
MultiSpeakerVoiceConfig({required this.speakerVoiceConfigs});
```

--------------------------------

### HarmBlockMethod Severity - Firebase AI

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/HarmBlockMethod.html

Use this enum value when the harm block method should consider both probability and severity scores for blocking. No specific setup is required beyond importing the enum.

```dart
const HarmBlockMethod('SEVERITY')
```

--------------------------------

### Initialize LiveGenerationConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveGenerationConfig/LiveGenerationConfig.html

Constructor for configuring live generation settings such as speech, audio transcription, and model parameters.

```dart
LiveGenerationConfig(
    {super.speechConfig,
    this.inputAudioTranscription,
    this.outputAudioTranscription,
    this.contextWindowCompression,
    super.responseModalities,
    super.maxOutputTokens,
    super.temperature,
    super.topP,
    super.topK,
    super.presencePenalty,
    super.frequencyPenalty,
    super.mediaResolution});
```

--------------------------------

### Initialize CitationMetadata

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/CitationMetadata/CitationMetadata.html

Constructor for creating a new instance of CitationMetadata with a list of citations.

```dart
CitationMetadata(this.citations);
```

--------------------------------

### Initialize ImageConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImageConfig/ImageConfig.html

Use this constructor to define the aspect ratio and size settings for image generation.

```dart
const ImageConfig({this.aspectRatio, this.imageSize});
```

--------------------------------

### Initialize Candidate instance

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Candidate/Candidate.html

Constructor for creating a new Candidate object with required content and optional metadata.

```dart
Candidate(this.content, this.safetyRatings, this.citationMetadata,
    this.finishReason, this.finishMessage,
    {this.groundingMetadata, this.urlContextMetadata});
```

--------------------------------

### Tool codeExecution({CodeExecution codeExecution})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Tool/codeExecution.html

Creates a Tool instance configured for Code Execution.

```APIDOC
## Tool codeExecution

### Description
Returns a Tool instance that enables the model to use Code Execution.

### Signature
`static Tool codeExecution({CodeExecution codeExecution = const CodeExecution()})`

### Parameters
- **codeExecution** (CodeExecution) - Optional - An instance of CodeExecution, defaults to `const CodeExecution()`.

### Returns
- **Tool** - A Tool instance configured for code execution.
```

--------------------------------

### Create Content with text static method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/text.html

Use this method to initialize a Content object with a user role and a single text part.

```dart
static Content text(String text) => Content('user', [TextPart(text)]);
```

--------------------------------

### Initialize WebGroundingChunk

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/WebGroundingChunk/WebGroundingChunk.html

Constructor for creating a new instance of WebGroundingChunk with optional metadata.

```dart
WebGroundingChunk({this.uri, this.title, this.domain});
```

--------------------------------

### Initialize LiveServerContent

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveServerContent/LiveServerContent.html

Constructor for creating a new instance of LiveServerContent with optional parameters for model turns and transcriptions.

```dart
LiveServerContent(
    {this.modelTurn,
    this.turnComplete,
    this.interrupted,
    this.inputTranscription,
    this.outputTranscription});
```

--------------------------------

### Initialize ExecutableCodePart

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ExecutableCodePart/ExecutableCodePart.html

Constructor definition for creating an instance of ExecutableCodePart with required language and code parameters.

```dart
ExecutableCodePart({
  required this.language,
  required this.code,
  bool? isThought,
}) : super(
        isThought: isThought,
        thoughtSignature: null,
      );
```

--------------------------------

### Implementation of startChat

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartChatExtension/startChat.html

The internal implementation of the startChat method, showing how parameters are passed to the ChatSession constructor.

```dart
ChatSession startChat(
        {List<Content>? history,
        List<SafetySetting>? safetySettings,
        GenerationConfig? generationConfig,
        int? maxTurns}) =>
    ChatSession._(generateContent, generateContentStream, history ?? [],
        safetySettings, generationConfig, tools, maxTurns ?? 5);
```

--------------------------------

### Initialize GoogleSearch

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GoogleSearch/GoogleSearch.html

Use this constant constructor to create a new instance of GoogleSearch.

```dart
const GoogleSearch();
```

--------------------------------

### Connect to Live Generation Service

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveGenerativeModel/connect.html

Establishes a connection to the service and returns a LiveSession. Requires appropriate backend configuration and authentication tokens.

```dart
Future<LiveSession> connect(
    {SessionResumptionConfig? sessionResumption}) async {
  final uri = _useVertexBackend ? _vertexAIUri() : _googleAIUri();
  final modelString =
      _useVertexBackend ? _vertexAIModelString() : _googleAIModelString();

  final headers = await BaseModel.firebaseTokens(
    _appCheck,
    _auth,
    _app,
    _useLimitedUseAppCheckTokens,
  )();

  return LiveSession.create(
    uri: uri,
    headers: headers,
    modelString: modelString,
    systemInstruction: _systemInstruction,
    tools: _tools,
    sessionResumption: sessionResumption,
    liveGenerationConfig: _liveGenerationConfig,
  );
}
```

--------------------------------

### Content(String? role, List<Part> parts)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/Content.html

Initializes a new Content object with an optional role and a list of parts.

```APIDOC
## Content Constructor

### Description
Creates a new instance of the Content class. This is used to structure data for AI interactions.

### Signature
Content(String? role, List<Part> parts)

### Parameters
- **role** (String?) - Optional - The role associated with the content (e.g., 'user' or 'model').
- **parts** (List<Part>) - Required - A list of Part objects representing the content segments.
```

--------------------------------

### Initialize PromptFeedback

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/PromptFeedback/PromptFeedback.html

Constructor for creating a new instance of PromptFeedback with optional block reasons and safety ratings.

```dart
PromptFeedback(this.blockReason, this.blockReasonMessage, this.safetyRatings);
```

--------------------------------

### Initialize ImagenSubjectConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenSubjectConfig/ImagenSubjectConfig.html

Constructor for creating an instance of ImagenSubjectConfig with optional description and type parameters.

```dart
ImagenSubjectConfig({
  this.description,
  this.type,
});
```

--------------------------------

### ImagenEditingConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenEditingConfig/ImagenEditingConfig.html

Initializes a new instance of ImagenEditingConfig with optional parameters for edit mode and edit steps.

```APIDOC
## ImagenEditingConfig constructor

### Description
Creates a new configuration object for Imagen editing operations.

### Signature
`ImagenEditingConfig({ImagenEditMode? editMode, int? editSteps})`

### Parameters
- **editMode** (ImagenEditMode?) - Optional - The mode to be used for image editing.
- **editSteps** (int?) - Optional - The number of steps to perform during the editing process.
```

--------------------------------

### Initialize ImagenStyleReference

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenStyleReference/ImagenStyleReference.html

Constructor for creating a new style reference instance with an image, optional description, and required reference ID.

```dart
ImagenStyleReference({
  required ImagenInlineImage image,
  String? description,
  required super.referenceId,
}) : super._(
        image: image,
        referenceConfig: ImagenStyleConfig(
          description: description,
        ),
        referenceType: _ReferenceType.style,
      );
```

--------------------------------

### LiveServerContent constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveServerContent/LiveServerContent.html

Initializes a new instance of LiveServerContent with optional parameters for model turns and transcription data.

```APIDOC
## LiveServerContent constructor

### Description
Creates a new instance of the LiveServerContent class to manage state for a live server interaction.

### Signature
LiveServerContent({Content? modelTurn, bool? turnComplete, bool? interrupted, Transcription? inputTranscription, Transcription? outputTranscription})

### Parameters
- **modelTurn** (Content) - Optional - The content generated by the model.
- **turnComplete** (bool) - Optional - Indicates if the turn is complete.
- **interrupted** (bool) - Optional - Indicates if the generation was interrupted.
- **inputTranscription** (Transcription) - Optional - The input transcription.
- **outputTranscription** (Transcription) - Optional - The output transcription.
```

--------------------------------

### ImageConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImageConfig/ImageConfig.html

Initializes a new instance of ImageConfig with optional aspect ratio and image size settings.

```APIDOC
## ImageConfig constructor

### Description
Initializes configuration options for generating images with Gemini.

### Signature
`const ImageConfig({ImageAspectRatio? aspectRatio, ImageSize? imageSize})`

### Parameters
- **aspectRatio** (ImageAspectRatio) - Optional - The desired aspect ratio for the generated image.
- **imageSize** (ImageSize) - Optional - The desired dimensions or size category for the generated image.
```

--------------------------------

### GenerateContentResponse(List<Candidate> candidates, PromptFeedback? promptFeedback, {UsageMetadata? usageMetadata})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GenerateContentResponse/GenerateContentResponse.html

Constructs a new GenerateContentResponse instance with the provided candidates, prompt feedback, and optional usage metadata.

```APIDOC
## GenerateContentResponse Constructor

### Description
Creates a new instance of the GenerateContentResponse class.

### Parameters
- **candidates** (List<Candidate>) - Required - A list of generated content candidates.
- **promptFeedback** (PromptFeedback?) - Required - Feedback regarding the prompt.
- **usageMetadata** (UsageMetadata?) - Optional - Metadata regarding the token usage of the request.
```

--------------------------------

### ImagenStyleConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenStyleConfig/ImagenStyleConfig.html

Initializes a new instance of the ImagenStyleConfig class with optional styling parameters.

```APIDOC
## ImagenStyleConfig constructor

### Description
Creates a new instance of ImagenStyleConfig to define styling configurations.

### Parameters
- **description** (String?) - Optional - A description for the style configuration.
```

--------------------------------

### Initialize SpeakerVoiceConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeakerVoiceConfig/SpeakerVoiceConfig.html

Use this constructor to create a new instance of SpeakerVoiceConfig by providing the required speaker and voiceName parameters.

```dart
SpeakerVoiceConfig({required this.speaker, required this.voiceName});
```

--------------------------------

### SessionResumptionConfig.resume(String handle)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SessionResumptionConfig/SessionResumptionConfig.resume.html

Creates a SessionResumptionConfig instance to resume a previous session using the provided session handle.

```APIDOC
## SessionResumptionConfig.resume(String handle)

### Description
Creates a SessionResumptionConfig to resume a previous session. The handle parameter is the session resumption handle received in a previous session's SessionResumptionUpdate.

### Parameters
- **handle** (String) - Required - The session resumption handle received in a previous session's SessionResumptionUpdate.
```

--------------------------------

### Candidate(Content content, List<SafetyRating>? safetyRatings, CitationMetadata? citationMetadata, FinishReason? finishReason, String? finishMessage, {GroundingMetadata? groundingMetadata, UrlContextMetadata? urlContextMetadata})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Candidate/Candidate.html

Constructor for creating a Candidate object with the specified content and metadata.

```APIDOC
## Candidate Constructor

### Description
Initializes a new Candidate instance with the provided content, safety ratings, and metadata.

### Signature
`Candidate(Content content, List<SafetyRating>? safetyRatings, CitationMetadata? citationMetadata, FinishReason? finishReason, String? finishMessage, {GroundingMetadata? groundingMetadata, UrlContextMetadata? urlContextMetadata})`

### Parameters
- **content** (Content) - Required - The content of the candidate.
- **safetyRatings** (List<SafetyRating>?) - Optional - List of safety ratings for the candidate.
- **citationMetadata** (CitationMetadata?) - Optional - Metadata regarding citations.
- **finishReason** (FinishReason?) - Optional - The reason the generation finished.
- **finishMessage** (String?) - Optional - A message explaining the finish status.
- **groundingMetadata** (GroundingMetadata?) - Optional - Metadata related to grounding.
- **urlContextMetadata** (UrlContextMetadata?) - Optional - Metadata related to URL context.
```

--------------------------------

### Initialize ImagenControlConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenControlConfig/ImagenControlConfig.html

Constructor for creating an instance of ImagenControlConfig with required and optional parameters.

```dart
ImagenControlConfig({
  required this.controlType,
  this.enableComputation,
  this.superpixelRegionSize,
  this.superpixelRuler,
});
```

--------------------------------

### Initialize Citation object

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Citation/Citation.html

Constructor used to create a new instance of the Citation class.

```dart
Citation(this.startIndex, this.endIndex, this.uri, this.license);
```

--------------------------------

### StartTemplateChatExtension

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai

An extension on TemplateGenerativeModel that provides a startChat method.

```APIDOC
## StartTemplateChatExtension

### Description
An extension on TemplateGenerativeModel that provides a `startChat` method for template-based generative models.
```

--------------------------------

### ImagenSubjectConfig()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenSubjectConfig/ImagenSubjectConfig.html

Initializes a new instance of the ImagenSubjectConfig class with optional description and reference type parameters.

```APIDOC
## ImagenSubjectConfig()

### Description
Creates a new configuration object for an Imagen subject.

### Parameters
- **description** (String?) - Optional - A description of the subject.
- **type** (ImagenSubjectReferenceType?) - Optional - The reference type of the subject.
```

--------------------------------

### Initialize ToolConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ToolConfig/ToolConfig.html

Constructor for initializing ToolConfig with optional function calling and retrieval configurations.

```dart
ToolConfig({this.functionCallingConfig, this.retrievalConfig});
```

--------------------------------

### FileData(String mimeType, String fileUri, {MediaResolution? mediaResolution, bool? isThought})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/FileData-class.html

Creates a new FileData instance to represent a media file in a prompt.

```APIDOC
## FileData(String mimeType, String fileUri, {MediaResolution? mediaResolution, bool? isThought})

### Description
Constructs a FileData object representing a Firebase Storage file to be used as part of a prompt.

### Parameters
- **mimeType** (String) - Required - The MIME type of the file.
- **fileUri** (String) - Required - The gs:// URI for the Firebase Storage reference.
- **mediaResolution** (MediaResolution?) - Optional - The resolution to use for this media part.
- **isThought** (bool?) - Optional - Indicates if this part is a thought.
```

--------------------------------

### Initialize GoogleMaps

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GoogleMaps/GoogleMaps.html

Use the constant constructor to instantiate the GoogleMaps widget.

```dart
const GoogleMaps();
```

--------------------------------

### Create a Tool instance with function declarations

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Tool/functionDeclarations.html

Use this static method to instantiate a Tool object containing a list of function declarations.

```dart
static Tool functionDeclarations(
    List<FunctionDeclaration> functionDeclarations) {
  return Tool._(functionDeclarations, null, null, null, null);
}
```

--------------------------------

### Implement codeExecution static method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Tool/codeExecution.html

Returns a Tool instance configured for code execution.

```dart
static Tool codeExecution(
    {CodeExecution codeExecution = const CodeExecution()}) {
  return Tool._(null, null, codeExecution, null, null);
}
```

--------------------------------

### Initialize ImagenEditingConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenEditingConfig/ImagenEditingConfig.html

Constructor for configuring image editing parameters.

```dart
ImagenEditingConfig({
  this.editMode,
  this.editSteps,
});
```

--------------------------------

### ImageConfig(ImageAspectRatio? aspectRatio, ImageSize? imageSize)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImageConfig-class.html

Initializes a new instance of the ImageConfig class with optional aspect ratio and image size settings.

```APIDOC
## ImageConfig(ImageAspectRatio? aspectRatio, ImageSize? imageSize)

### Description
Initializes configuration options for generating images with Gemini models.

### Parameters
- **aspectRatio** (ImageAspectRatio?) - Optional - The aspect ratio of generated images.
- **imageSize** (ImageSize?) - Optional - The size of the generated images.
```

--------------------------------

### Initialize GenerationConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GenerationConfig/GenerationConfig.html

The constructor accepts various optional parameters to control model output. Note that responseSchema and responseJsonSchema cannot both be set simultaneously.

```dart
GenerationConfig({
  super.candidateCount,
  this.stopSequences,
  super.maxOutputTokens,
  super.temperature,
  super.topP,
  super.topK,
  super.presencePenalty,
  super.frequencyPenalty,
  super.responseModalities,
  super.mediaResolution,
  super.speechConfig,
  this.responseMimeType,
  this.responseSchema,
  this.responseJsonSchema,
  this.thinkingConfig,
  this.imageConfig,
}) : assert(responseSchema == null || responseJsonSchema == null,
          'responseSchema and responseJsonSchema cannot both be set.');
```

--------------------------------

### Implement Content.model static method

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/model.html

Creates a Content instance with the 'model' role and the provided parts.

```dart
static Content model(Iterable<Part> parts) => Content('model', [...parts]);
```

--------------------------------

### Initialize ThinkingConfig with ThinkingBudget

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ThinkingConfig/ThinkingConfig.withThinkingBudget.html

Use this factory constructor to set the thinking budget for Gemini models 2.5 and earlier.

```dart
factory ThinkingConfig.withThinkingBudget(int? thinkingBudget,
        {bool? includeThoughts}) =>
    ThinkingConfig._(
        thinkingBudget: thinkingBudget, includeThoughts: includeThoughts);
```

--------------------------------

### ThinkingConfig Constructors

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ThinkingConfig-class.html

Provides information on how to instantiate the ThinkingConfig class using different constructors.

```APIDOC
## ThinkingConfig Constructors

### ThinkingConfig()

Deprecated public constructor of ThinkingConfig.

### ThinkingConfig.withThinkingBudget(int? thinkingBudget, {bool? includeThoughts})

Initializes ThinkingConfig with `thinkingBudget`.

### ThinkingConfig.withThinkingLevel(ThinkingLevel? thinkingLevel, {bool? includeThoughts})

Initializes ThinkingConfig with `thinkingLevel`.
```

--------------------------------

### resumeSession()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveSession-class.html

Resumes an existing live session with the server.

```APIDOC
## resumeSession()

### Description
Resumes an existing live session with the server.

### Parameters
- **sessionResumption** (SessionResumptionConfig?) - Optional - Configuration for resuming the session.

### Signature
`Future<void> resumeSession({SessionResumptionConfig? sessionResumption})`
```

--------------------------------

### AudioTranscriptionConfig()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/AudioTranscriptionConfig/AudioTranscriptionConfig.html

Initializes a new instance of the AudioTranscriptionConfig class.

```APIDOC
## AudioTranscriptionConfig()

### Description
Initializes a new instance of the AudioTranscriptionConfig class with default values.

### Method
Constructor

### Endpoint
N/A

### Parameters
This constructor does not accept any parameters.

### Request Example
```json
AudioTranscriptionConfig()
```

### Response
#### Success Response (Instance)
- **AudioTranscriptionConfig** (object) - An instance of the AudioTranscriptionConfig class.
```

--------------------------------

### Initialize ThinkingConfig with ThinkingLevel

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ThinkingConfig/ThinkingConfig.withThinkingLevel.html

Use this factory constructor to configure thinking parameters for supported Gemini models.

```dart
factory ThinkingConfig.withThinkingLevel(ThinkingLevel? thinkingLevel,
        {bool? includeThoughts}) =>
    ThinkingConfig._(
        thinkingLevel: thinkingLevel, includeThoughts: includeThoughts);
```

--------------------------------

### Initialize SessionResumptionConfig.resume

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SessionResumptionConfig/SessionResumptionConfig.resume.html

Use this constructor to create a configuration object for resuming a session with a specific handle.

```dart
SessionResumptionConfig.resume(String this.handle);
```

--------------------------------

### UrlContext()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/UrlContext/UrlContext.html

Creates a new instance of the UrlContext class.

```APIDOC
## UrlContext()

### Description
Creates a new constant instance of the UrlContext class.

### Signature
`const UrlContext()`
```

--------------------------------

### SpeakerVoiceConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeakerVoiceConfig/SpeakerVoiceConfig.html

Initializes a new instance of SpeakerVoiceConfig with the required speaker and voice name parameters.

```APIDOC
## SpeakerVoiceConfig constructor

### Description
Initializes a new instance of the SpeakerVoiceConfig class.

### Signature
SpeakerVoiceConfig({required String speaker, required String voiceName})

### Parameters
- **speaker** (String) - Required - The identifier for the speaker.
- **voiceName** (String) - Required - The name of the voice to be used.
```

--------------------------------

### Initialize GenerateContentResponse

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GenerateContentResponse/GenerateContentResponse.html

Use this constructor to create a new instance of GenerateContentResponse with the required candidates and prompt feedback.

```dart
GenerateContentResponse(this.candidates, this.promptFeedback,
    {this.usageMetadata});
```

--------------------------------

### Implementation of startChat

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/StartTemplateChatExtension/startChat.html

The internal implementation of the startChat method returning a TemplateChatSession instance.

```dart
TemplateChatSession startChat(String templateId,
        {required Map<String, Object?> inputs,
        List<Content>? history,
        List<TemplateTool>? tools,
        TemplateToolConfig? toolConfig,
        int? maxTurns}) =>
    TemplateChatSession._(
        templateGenerateContentWithHistory,
        templateGenerateContentWithHistoryStream,
        templateId,
        inputs,
        history ?? [],
        tools ?? [],
        toolConfig,
        maxTurns ?? 5);
```

--------------------------------

### Initialize ImagenFormat

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenFormat/ImagenFormat.html

Constructor for creating an instance of ImagenFormat with a specified mime type and optional compression quality.

```dart
ImagenFormat(this.mimeType, this.compressionQuality);
```

--------------------------------

### TextPart Class Overview

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/TextPart-class.html

This section provides an overview of the TextPart class, its inheritance, constructors, properties, and methods.

```APIDOC
## TextPart Class
A Part with the text content.

### Inheritance
* Object
* Part
* TextPart

## Constructors

### TextPart(String text, {bool? isThought})

`const`

### TextPart.forTest(String text, {bool? isThought, String? thoughtSignature})

`const`

## Properties

### hashCode → int
The hash code for this object.
`no setter` `inherited`

### isThought → bool?
`final` `inherited`

### runtimeType → Type
A representation of the runtime type of the object.
`no setter` `inherited`

### text → String
The text content of the Part
`final`

## Methods

### noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
`inherited`

### toJson() → Object
Convert the Part content to json format.
`override`

### toString() → String
A string representation of this object.
`inherited`

## Operators

### operator ==(Object other) → bool
The equality operator.
`inherited`
```

--------------------------------

### Content.text(String text)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/Content/text.html

Creates a new Content instance with a 'user' role containing the provided text string.

```APIDOC
## Content.text

### Description
Creates a Content object initialized with a 'user' role and a single TextPart containing the specified string.

### Signature
`static Content text(String text)`

### Parameters
- **text** (String) - Required - The text content to be wrapped in a TextPart.

### Returns
- **Content** - A Content object containing the provided text.
```

--------------------------------

### Implement JSONSchema.string constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/JSONSchema/JSONSchema.string.html

Defines a schema for a string value with optional parameters for description, title, nullability, and format.

```dart
JSONSchema.string({
  String? description,
  String? title,
  bool? nullable,
  String? format,
}) : this(
        SchemaType.string,
        description: description,
        title: title,
        nullable: nullable,
        format: format,
      );
```

--------------------------------

### Initialize LiveServerResponse

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveServerResponse/LiveServerResponse.html

The constructor requires a LiveServerMessage instance to be passed during initialization.

```dart
LiveServerResponse({required this.message});
```

--------------------------------

### Future<void> send({Content? input, bool turnComplete = false})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/LiveSession/send.html

Sends content to the server. The input parameter is optional, and turnComplete defaults to false.

```APIDOC
## send

### Description
Sends content to the server during a live session.

### Signature
`Future<void> send({Content? input, bool turnComplete = false})`

### Parameters
- **input** (Content) - Optional - The content to send to the server.
- **turnComplete** (bool) - Optional - Indicates if the current turn is complete. Defaults to false.
```

--------------------------------

### Initialize SpeechConfig

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeechConfig/SpeechConfig.html

Constructs a new SpeechConfig instance for a single-speaker configuration.

```dart
SpeechConfig({this.voiceName, this.languageCode})
    : multiSpeakerVoiceConfig = null;
```

--------------------------------

### ImagenGenerationConfig constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenGenerationConfig/ImagenGenerationConfig.html

Initializes a new configuration object for Imagen generation tasks.

```APIDOC
## ImagenGenerationConfig

### Description
Creates a new instance of ImagenGenerationConfig to define parameters for image generation.

### Parameters
- **numberOfImages** (int?) - Optional - The number of images to generate.
- **negativePrompt** (String?) - Optional - A prompt describing elements to exclude from the generated images.
- **aspectRatio** (ImagenAspectRatio?) - Optional - The desired aspect ratio for the output images.
- **imageFormat** (ImagenFormat?) - Optional - The file format for the generated images.
- **addWatermark** (bool?) - Optional - Whether to include a watermark on the generated images.
```

--------------------------------

### Initialize ImagenFormat.png

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenFormat/ImagenFormat.png.html

Creates an instance of ImagenFormat with the PNG mime type.

```dart
ImagenFormat.png() : this('image/png', null);
```

--------------------------------

### ImagenRawImage Constructor

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenRawImage-class.html

Initializes a new instance of the ImagenRawImage class.

```APIDOC
## ImagenRawImage Constructor

### Description
Initializes a new instance of the ImagenRawImage class.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
None
```

--------------------------------

### SlidingWindow({int? targetTokens})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SlidingWindow/SlidingWindow.html

Creates a new instance of SlidingWindow with an optional target token limit.

```APIDOC
## SlidingWindow constructor

### Description
Creates a new SlidingWindow instance to manage context window size.

### Signature
`SlidingWindow({int? targetTokens})`

### Parameters
- **targetTokens** (int?) - Optional - The target number of tokens to keep in the context window.
```

--------------------------------

### Initialize CodeExecution

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/CodeExecution/CodeExecution.html

Use this constructor to create a new instance of the CodeExecution class.

```dart
const CodeExecution();
```

--------------------------------

### Initialize SpeechConfig.multiSpeaker

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SpeechConfig/SpeechConfig.multiSpeaker.html

Constructs a new instance of SpeechConfig for multi-speaker configurations.

```dart
SpeechConfig.multiSpeaker(
    {required this.multiSpeakerVoiceConfig, this.languageCode})
    : voiceName = null;
```

--------------------------------

### PromptFeedback Class

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/PromptFeedback-class.html

Provides details about the PromptFeedback class, including its constructor, properties, and methods.

```APIDOC
## PromptFeedback Class

### Description
Feedback metadata of a prompt specified in a GenerativeModel request.

### Constructor
**PromptFeedback**(BlockReason? blockReason, String? blockReasonMessage, List<SafetyRating> safetyRatings)

### Properties
- **blockReason** (BlockReason?) - If set, the prompt was blocked and no candidates are returned. final
- **blockReasonMessage** (String?) - Message for the block reason. final
- **hashCode** (int) - The hash code for this object. no setter inherited
- **runtimeType** (Type) - A representation of the runtime type of the object. no setter inherited
- **safetyRatings** (List<SafetyRating>) - Ratings for safety of the prompt. final

### Methods
- **noSuchMethod**(Invocation invocation) → dynamic - Invoked when a nonexistent method or property is accessed. inherited
- **toString**() → String - A string representation of this object. inherited

### Operators
- **operator ==**(Object other) → bool - The equality operator. inherited
```

--------------------------------

### Initialize ImagenSafetySettings

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ImagenSafetySettings/ImagenSafetySettings.html

Constructor for defining safety and person filter levels.

```dart
ImagenSafetySettings(this.safetyFilterLevel, this.personFilterLevel);
```

--------------------------------

### generateContent(Iterable<Content> prompt, {List<SafetySetting>? safetySettings, GenerationConfig? generationConfig, List<Tool>? tools, ToolConfig? toolConfig})

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GenerativeModel/generateContent.html

Generates content responding to the provided prompt by sending a 'generateContent' API request to the configured model.

```APIDOC
## generateContent

### Description
Generates content responding to the provided prompt. This method sends a 'generateContent' API request for the configured model and waits for the response.

### Signature
`Future<GenerateContentResponse> generateContent(Iterable<Content> prompt, {List<SafetySetting>? safetySettings, GenerationConfig? generationConfig, List<Tool>? tools, ToolConfig? toolConfig})`

### Parameters
- **prompt** (Iterable<Content>) - Required - The input content to generate a response for.
- **safetySettings** (List<SafetySetting>) - Optional - Configuration for safety filters.
- **generationConfig** (GenerationConfig) - Optional - Configuration for the generation process.
- **tools** (List<Tool>) - Optional - Tools available for the model to use.
- **toolConfig** (ToolConfig) - Optional - Configuration for the provided tools.

### Example
```dart
final response = await model.generateContent([Content.text(prompt)]);
print(response.text);
```
```

--------------------------------

### Initialize CodeExecutionResultPart

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/CodeExecutionResultPart/CodeExecutionResultPart.html

Constructor for creating a new instance of CodeExecutionResultPart with required outcome and output parameters.

```dart
CodeExecutionResultPart({
  required this.outcome,
  required this.output,
  bool? isThought,
}) : super(
        isThought: isThought,
        thoughtSignature: null,
      );
```

--------------------------------

### GoogleMaps()

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/GoogleMaps/GoogleMaps.html

Creates a new instance of the GoogleMaps class.

```APIDOC
## GoogleMaps()

### Description
Creates a new instance of the GoogleMaps class using the constant constructor.

### Signature
`const GoogleMaps()`
```

--------------------------------

### Initialize SlidingWindow

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SlidingWindow/SlidingWindow.html

Creates a new instance of SlidingWindow with an optional targetTokens parameter.

```dart
SlidingWindow({this.targetTokens});
```

--------------------------------

### SlidingWindow(int? targetTokens)

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/SlidingWindow-class.html

Creates a new instance of the SlidingWindow class to configure the session reduction target.

```APIDOC
## SlidingWindow(int? targetTokens)

### Description
Creates a SlidingWindow instance to configure the sliding window context compression mechanism.

### Parameters
- **targetTokens** (int?) - Optional - The session reduction target, representing the number of tokens to keep.
```

--------------------------------

### Initialize ServerException

Source: https://pub.dev/documentation/firebase_ai/latest/firebase_ai/ServerException/ServerException.html

Constructor for creating a new instance of ServerException with a provided error message.

```dart
ServerException(this.message);
```
Tokens:
Raw