google_mlkit_genai_rewriting 0.4.0

A Flutter plugin to use Google's ML Kit GenAI Rewriting API to rewrite text in different styles.

Google's ML Kit GenAI Rewriting for Flutter

NOTE: This feature is still in Beta, and it is only available for Android. Stay tuned for updates on Google's website and request the feature here.

A Flutter plugin to use Google's ML Kit GenAI Rewriting API to rewrite text in different styles.

PLEASE READ THIS before continuing or posting a new issue:

• Google's ML Kit was built only for mobile platforms: iOS and Android apps. Web or any other platform is not supported, you can request support for those platforms to Google in their repo.

• This plugin is not sponsored or maintained by Google. The authors are developers excited about Machine Learning that wanted to expose Google's native APIs to Flutter.

• Google's ML Kit APIs are only developed natively for iOS and Android. This plugin uses Flutter Platform Channels as explained here.

  Messages are passed between the client (the app/plugin) and host (platform) using platform channels as illustrated in this diagram:

  

  Messages and responses are passed asynchronously, to ensure the user interface remains responsive. To read more about platform channels go here.

  Because this plugin uses platform channels, no Machine Learning processing is done in Flutter/Dart, all the calls are passed to the native platform using MethodChannel in Android and FlutterMethodChannel in iOS, and executed using Google's native APIs. Think of this plugin as a bridge between your app and Google's native ML Kit APIs. This plugin only passes the call to the native API and the processing is done by Google's API. It is important that you understand this concept when it comes to debugging errors for your ML model and/or app.

• Since the plugin uses platform channels, you may encounter issues with the native API. Before submitting a new issue, identify the source of the issue. You can run both iOS and/or Android native example apps by Google and make sure that the issue is not reproducible with their native examples. If you can reproduce the issue in their apps then report the issue to Google. The authors do not have access to the source code of their native APIs, so you need to report the issue to them. If you find that their example apps are okay and still you have an issue using this plugin, then look at our closed and open issues. If you cannot find anything that can help you then report the issue and provide enough details. Be patient, someone from the community will eventually help you.

Requirements

iOS

This feature is still in Beta, and it is only available for Android. Stay tuned for updates on Google's website and request the feature here.

Android

• minSdkVersion: 26
• targetSdkVersion: 36
• compileSdkVersion: 36

⚠️ Important: This API is built on top of AICore and will not support all Android devices. It requires devices with AICore support. Please check device compatibility before using this feature in production.

⚠️ Production Disclaimer: Using this plugin in production is the responsibility of the developers consuming the plugin, not the authors. The authors provide this plugin as-is and are not responsible for any issues, failures, or compatibility problems that may arise from using this plugin in production environments.

Usage

Rewriting

Create an instance of Rewriter

final rewriter = Rewriter(
  outputType: RewritingOutputType.formal, // formal, concise, emoji
  language: RewritingLanguage.english, // english, japanese, korean
);

Check feature status

final status = await rewriter.checkFeatureStatus();
if (status == FeatureStatus.downloadable) {
  await rewriter.downloadFeature();
} else if (status == FeatureStatus.available) {
  // Start rewriting
}

Process text

final text = "Your text here...";
final rewritten = await rewriter.runInference(text);
print('Rewritten: $rewritten');

Note: On Android, the native Rewriter client is currently initialized with default RewriterOptions.builder(context).build() options, downloadFeature() awaits completion without invoking its optional Dart progress callbacks, and runInferenceStreaming() is not yet implemented on the native Android side.

Release resources with close()

rewriter.close();

Example app

Find the example app here. Note that the GenAI screens in the example app are currently placeholder views.

Contributing

Contributions are welcome. In case of any problems look at existing issues, if you cannot find anything related to your problem then open an issue. Create an issue before opening a pull request for non-trivial fixes. In case of trivial fixes open a pull request directly.