Skip to content

feat(vertexai): Add responseModality #17326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ void main() async {

var vertexInstance =
FirebaseVertexAI.instanceFor(auth: FirebaseAuth.instance);
final model = vertexInstance.generativeModel(model: 'gemini-1.5-flash');
final model = vertexInstance.generativeModel(model: 'gemini-2.0-flash');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: gemini-2.0-flash doesn't support multi-modal output yet (only gemini-2.0-flash-exp). We probably want to keep it as gemini-2.0-flash here but would it be possible to override it in _multiModalityResponse ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather to add comments in _multiModalityResponse function, since for developer api feature, I'd rather to have model instantiate in one central place ot reduce the confusion of the sample app behavior


runApp(GenerativeAISample(model: model));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,17 @@ class _ChatPageState extends State<ChatPage> {
const SizedBox.square(
dimension: 15,
),
if (!_loading)
IconButton(
onPressed: () async {
await _multiModalityResponse(_textController.text);
},
icon: Icon(
Icons.model_training,
color: Theme.of(context).colorScheme.primary,
),
tooltip: 'MultiModality response',
),
if (!_loading)
IconButton(
onPressed: () async {
Expand Down Expand Up @@ -152,6 +163,62 @@ class _ChatPageState extends State<ChatPage> {
}
}

Future<void> _multiModalityResponse(String message) async {
setState(() {
_loading = true;
});

try {
_messages.add(MessageData(text: message, fromUser: true));
var response = await widget.model.generateContent(
[Content.text(message)],
generationConfig: GenerationConfig(
responseModalities: [
ResponseModalities.text,
ResponseModalities.audio,
],
),
);
var inlineDatas = response.inlineDatas.toList();

if (inlineDatas.isEmpty) {
_showError('No response from API.');
return;
} else {
for (final inlineData in inlineDatas) {
if (inlineData.mimeType.contains('image')) {
_messages.add(
MessageData(
text: response.text,
image: Image.memory(inlineData.bytes),
fromUser: false,
),
);
} else {
if (inlineData.mimeType.contains('audio')) {
print('Got audio response');
}
}
}
setState(() {
_loading = false;
_scrollDown();
});
}
} catch (e) {
_showError(e.toString());
setState(() {
_loading = false;
});
} finally {
_textController.clear();
setState(() {
_loading = false;
});
_textFieldFocus.requestFocus();
}
}

void _showError(String message) {
showDialog<void>(
context: context,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export 'src/api.dart'
HarmProbability,
HarmBlockMethod,
PromptFeedback,
ResponseModalities,
SafetyRating,
SafetySetting,
// TODO(cynthiajiang) remove in next breaking change.
Expand Down Expand Up @@ -72,7 +73,6 @@ export 'src/live_api.dart'
show
LiveGenerationConfig,
SpeechConfig,
ResponseModalities,
LiveServerMessage,
LiveServerContent,
LiveServerToolCall,
Expand Down
38 changes: 38 additions & 0 deletions packages/firebase_vertexai/firebase_vertexai/lib/src/api.dart
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,15 @@ final class GenerateContentResponse {
Iterable<FunctionCall> get functionCalls =>
candidates.firstOrNull?.content.parts.whereType<FunctionCall>() ??
const [];

/// The inline data parts of the first candidate in [candidates], if any.
///
/// Returns an empty list if there are no candidates, or if the first
/// candidate has no [InlineDataPart] parts. There is no error thrown if the
/// prompt or response were blocked.
Iterable<InlineDataPart> get inlineDatas =>
candidates.firstOrNull?.content.parts.whereType<InlineDataPart>() ??
const [];
}

/// Feedback metadata of a prompt specified in a [GenerativeModel] request.
Expand Down Expand Up @@ -650,6 +659,24 @@ enum HarmBlockMethod {
Object toJson() => _jsonString;
}

/// The available response modalities.
enum ResponseModalities {
/// Text response modality.
text('TEXT'),

/// Image response modality.
image('IMAGE'),

/// Audio response modality.
audio('AUDIO');

const ResponseModalities(this._jsonString);
final String _jsonString;

/// Convert to json format
String toJson() => _jsonString;
}

/// Configuration options for model generation and outputs.
abstract class BaseGenerationConfig {
// ignore: public_member_api_docs
Expand All @@ -661,6 +688,7 @@ abstract class BaseGenerationConfig {
this.topK,
this.presencePenalty,
this.frequencyPenalty,
this.responseModalities,
});

/// Number of generated responses to return.
Expand Down Expand Up @@ -737,6 +765,9 @@ abstract class BaseGenerationConfig {
/// for more details.
final double? frequencyPenalty;

/// The list of desired response modalities.
final List<ResponseModalities>? responseModalities;

// ignore: public_member_api_docs
Map<String, Object?> toJson() => {
if (candidateCount case final candidateCount?)
Expand All @@ -750,6 +781,9 @@ abstract class BaseGenerationConfig {
'presencePenalty': presencePenalty,
if (frequencyPenalty case final frequencyPenalty?)
'frequencyPenalty': frequencyPenalty,
if (responseModalities case final responseModalities?)
'responseModalities':
responseModalities.map((modality) => modality.toJson()).toList(),
};
}

Expand All @@ -765,6 +799,7 @@ final class GenerationConfig extends BaseGenerationConfig {
super.topK,
super.presencePenalty,
super.frequencyPenalty,
super.responseModalities,
this.responseMimeType,
this.responseSchema,
});
Expand Down Expand Up @@ -990,6 +1025,9 @@ SafetyRating _parseSafetyRating(Object? jsonObject) {
if (jsonObject is! Map) {
throw unhandledFormat('SafetyRating', jsonObject);
}
if (jsonObject.isEmpty) {
return SafetyRating(HarmCategory.unknown, HarmProbability.unknown);
}
return SafetyRating(HarmCategory._parseValue(jsonObject['category']),
HarmProbability._parseValue(jsonObject['probability']),
probabilityScore: jsonObject['probabilityScore'] as double?,
Expand Down
27 changes: 3 additions & 24 deletions packages/firebase_vertexai/firebase_vertexai/lib/src/live_api.dart
Original file line number Diff line number Diff line change
Expand Up @@ -71,30 +71,12 @@ class SpeechConfig {
};
}

/// The available response modalities.
enum ResponseModalities {
/// Text response modality.
text('TEXT'),

/// Image response modality.
image('IMAGE'),

/// Audio response modality.
audio('AUDIO');

const ResponseModalities(this._jsonString);
final String _jsonString;

/// Convert to json format
String toJson() => _jsonString;
}

/// Configures live generation settings.
final class LiveGenerationConfig extends BaseGenerationConfig {
// ignore: public_member_api_docs
LiveGenerationConfig({
this.speechConfig,
this.responseModalities,
super.responseModalities,
super.candidateCount,
super.maxOutputTokens,
super.temperature,
Expand All @@ -107,17 +89,14 @@ final class LiveGenerationConfig extends BaseGenerationConfig {
/// The speech configuration.
final SpeechConfig? speechConfig;

/// The list of desired response modalities.
final List<ResponseModalities>? responseModalities;
// /// The list of desired response modalities.
// final List<ResponseModalities>? responseModalities;

@override
Map<String, Object?> toJson() => {
...super.toJson(),
if (speechConfig case final speechConfig?)
'speechConfig': speechConfig.toJson(),
if (responseModalities case final responseModalities?)
'responseModalities':
responseModalities.map((modality) => modality.toJson()).toList(),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// limitations under the License.
import 'dart:typed_data';

import 'package:firebase_vertexai/src/api.dart';
import 'package:firebase_vertexai/src/content.dart';
import 'package:firebase_vertexai/src/error.dart';
import 'package:firebase_vertexai/src/live_api.dart';
Expand Down
Loading