API GenAI Proofreading

Cette API est proposée en version bêta et n'est soumise à aucun contrat de niveau de service ni à aucun règlement d'obsolescence. Des modifications susceptibles d'affecter la rétrocompatibilité peuvent être apportées à cette API.

Avec l'API de relecture GenAI de ML Kit, vous pouvez aider les utilisateurs à vérifier leur grammaire et leur orthographe dans de courts passages de texte.

Capacités clés

• Relire le texte saisi au clavier ou par commande vocale
• Les requêtes renvoient au moins une suggestion. Si plusieurs suggestions sont renvoyées, les résultats sont triés par ordre de confiance décroissant.

Exemples de résultats

Entrée	Type d'entrée	Sortie
this is a short msg	Clavier	Ceci est un court message
Le projet est presque terminé, mais doit être examiné	Clavier	Le projet est presque terminé, mais doit être examiné
Veuillez me rejoindre à l'ours,	Voice	Veuillez me retrouver au bar.

Premiers pas

Remarque :Cette API nécessite le niveau d'API Android 26 ou supérieur.

Pour commencer à utiliser l'API de relecture GenAI, ajoutez cette dépendance au fichier de compilation de votre projet.

implementation("com.google.mlkit:genai-proofreading:1.0.0-beta1")

Ensuite, configurez et obtenez un client Proofreader avec des paramètres de langue et de type de saisie spécifiques. Vérifiez et assurez-vous que les fonctionnalités de modèle sur l'appareil nécessaires sont disponibles (en déclenchant un téléchargement si nécessaire). Envoyez le texte que vous souhaitez analyser dans un ProofreadingRequest, exécutez l'inférence de relecture et, enfin, traitez les suggestions renvoyées pour corriger le texte.

Kotlin

val textToProofread = "The praject is compleet but needs too be reviewd"

// Define task with required input and output format
val options = ProofreaderOptions.builder(context)
    // InputType can be KEYBOARD or VOICE. VOICE indicates that
    // the user generated text based on audio input.
    .setInputType(ProofreaderOptions.InputType.KEYBOARD)
    // Refer to ProofreaderOptions.Language for available
    // languages
    .setLanguage(ProofreaderOptions.Language.ENGLISH)
    .build()
val proofreader = Proofreading.getClient(options)

suspend fun prepareAndStartProofread() {
    // Check feature availability, status will be one of the
    // following: UNAVAILABLE, DOWNLOADABLE, DOWNLOADING, AVAILABLE
    val featureStatus = proofreader.checkFeatureStatus().await()

    if (featureStatus == FeatureStatus.DOWNLOADABLE) {
        // Download feature if necessary.
        // If downloadFeature is not called, the first inference
        // request will also trigger the feature to be downloaded
        // if it's not already downloaded.
        proofreader.downloadFeature(object : DownloadCallback {
            override fun onDownloadStarted(bytesToDownload: Long) { }

            override fun onDownloadFailed(e: GenAiException) { }

            override fun onDownloadProgress(
                totalBytesDownloaded: Long
            ) {}

            override fun onDownloadCompleted() {
                startProofreadingRequest(textToProofread, proofreader)
            }
        })
    } else if (featureStatus == FeatureStatus.DOWNLOADING) {
        // Inference request will automatically run once feature is
        // downloaded.
        // If Gemini Nano is already downloaded on the device, the
        // feature-specific LoRA adapter model will be downloaded
        // very quickly. However, if Gemini Nano is not already
        // downloaded, the download process may take longer.
        startProofreadingRequest(textToProofread, proofreader)
    } else if (featureStatus == FeatureStatus.AVAILABLE) {
        startProofreadingRequest(textToProofread, proofreader)
    }
}

suspend fun startProofreadingRequest(
    text: String, proofreader: Proofreader
) {
    // Create task request
    val proofreadingRequest =
        ProofreadingRequest.builder(text).build()

    // Start proofreading request with non-streaming response
    // More than 1 result may be returned. If multiple suggestions
    // are returned, results will be sorted by descending confidence.
    val proofreadingResults =
        proofreader.runInference(proofreadingRequest).await().results

    // You can also start a streaming request
    // proofreader.runInference(proofreadingRequest) { newText ->
    //     // show new text in UI
    // }
}

// Be sure to release the resource when no longer needed
// For example, on viewModel.onCleared() or activity.onDestroy()
proofreader.close()

Java

String textToProofread = "The praject is compleet but needs too be reviewd";

// Define task with required input and output format
ProofreaderOptions proofreaderOptions = 
    ProofreaderOptions
        .builder(context)
        // InputType can be KEYBOARD or VOICE. VOICE indicates that the
        // user generated text based on audio input.
        .setInputType(ProofreaderOptions.InputType.KEYBOARD)
        // Refer to ProofreaderOptions.Language for available languages
        .setLanguage(ProofreaderOptions.Language.ENGLISH)
        .build();
Proofreader proofreader = Proofreading.getClient(proofreaderOptions);

void prepareAndStartProofread(Context context) throws ExecutionException,
        InterruptedException {
    // Check feature availability, status will be one of the following:
    // UNAVAILABLE, DOWNLOADABLE, DOWNLOADING, AVAILABLE
    try {
        int featureStatus = proofreader.checkFeatureStatus().get();
        if (featureStatus == FeatureStatus.DOWNLOADABLE) {
            // Download feature if necessary.
            // If downloadFeature is not called, the first inference request
            // will also trigger the feature to be downloaded if it's not
            // already downloaded.
            proofreader.downloadFeature(new DownloadCallback() {
                @Override
                public void onDownloadCompleted() {
                    startProofreadingRequest(textToProofread, proofreader);
                }

                @Override
                public void onDownloadFailed(GenAiException e) {
                }

                @Override
                public void onDownloadProgress(long totalBytesDownloaded) {
                }

                @Override
                public void onDownloadStarted(long bytesDownloaded) {
                }
            });
        } else if (featureStatus == FeatureStatus.DOWNLOADING) {
            // Inference request will automatically run once feature is
            // downloaded.
            // If Gemini Nano is already downloaded on the device, the
            // feature-specific LoRA adapter model will be downloaded
            // very quickly. However, if Gemini Nano is not already
            // downloaded, the download process may take longer.
            startProofreadingRequest(textToProofread, proofreader);
        } else if (featureStatus == FeatureStatus.AVAILABLE) {
            startProofreadingRequest(textToProofread, proofreader);
        }
    } catch (ExecutionException | InterruptedException e) {
        e.printStackTrace();
    }
}

void startProofreadingRequest(String text, Proofreader proofreader) {
    // Create task request
    ProofreadingRequest proofreadingRequest = ProofreadingRequest
            .builder(text).build();

    try {
        // Start proofreading request with non-streaming response
        // More than 1 result may be returned. If multiple suggestions are
        // returned, results will be sorted by descending confidence.
        proofreader.runInference(proofreadingRequest).get().getResults();

        // You can also start a streaming request
        // proofreader.runInference(proofreadingRequest, newText -> {
        //     // Show new text in UI
        // });
    } catch (ExecutionException | InterruptedException e) {
        e.printStackTrace();
    }
}

// Be sure to release the resource when no longer needed
// For example, on viewModel.onCleared() or activity.onDestroy()
proofreader.close();

Comment le modèle gère-t-il les différents types d'entrée ?

Lorsque le modèle dispose de plus d'informations sur la façon dont l'utilisateur a saisi le texte (clavier ou voix), il peut mieux prédire le type d'erreurs qui peuvent être présentes. Le texte saisi au clavier est plus susceptible de contenir des fautes de frappe avec les touches à proximité, tandis que le texte saisi par commande vocale est plus susceptible de contenir des fautes de frappe pour les mots à la même prononciation.

Fonctionnalités compatibles et limites

La relecture est disponible pour les langues suivantes: allemand, anglais, coréen, espagnol, français, italien et japonais. Elles sont définies dans ProofreaderOptions.Language. La valeur doit comporter moins de 256 jetons.

La disponibilité de la configuration de la fonctionnalité spécifique (spécifiée par ProofreaderOptions) peut varier en fonction de la configuration de l'appareil en question et des modèles téléchargés sur l'appareil.

Le moyen le plus fiable pour les développeurs de s'assurer que la fonctionnalité d'API prévue est compatible avec un appareil avec le ProofreaderOptions demandé consiste à appeler la méthode checkFeatureStatus(). Cette méthode fournit l'état définitif de la disponibilité des fonctionnalités sur l'appareil au moment de l'exécution.

Remarque :Les différences matérielles entre les différents types d'appareils peuvent entraîner des différences entre les versions du modèle de base Gemini Nano et, par conséquent, entre les sorties de l'API ML Kit GenAI. Des adaptateurs LoRA sont appliqués pour atténuer les différences.

Problèmes de configuration courants

Remarque :Cette API n'est pas compatible avec les appareils dotés d'un démarreur de système d'exploitation déverrouillé.

Les API GenAI de ML Kit s'appuient sur l'application Android AICore pour accéder à Gemini Nano. Lorsqu'un appareil vient d'être configuré (y compris après une réinitialisation) ou que l'application AICore vient d'être réinitialisée (par exemple, en effaçant les données, en désinstallant puis en réinstallant l'application), il est possible qu'elle n'ait pas le temps de terminer l'initialisation (y compris le téléchargement des dernières configurations à partir du serveur). Par conséquent, les API ML Kit GenAI risquent de ne pas fonctionner comme prévu. Voici les messages d'erreur de configuration courants que vous pouvez rencontrer et la marche à suivre pour les gérer:

Exemple de message d'erreur	Comment gérer
Échec d'AICore avec le type d'erreur 4-CONNECTION_ERROR et le code d'erreur 601-BINDING_FAILURE: échec de la liaison du service AICore.	Cela peut se produire lorsque vous installez l'application à l'aide des API ML Kit GenAI immédiatement après la configuration de l'appareil ou lorsque AICore est désinstallé après l'installation de votre application. Mettez à jour l'application AICore, puis réinstallez votre application. Le problème devrait être résolu.
Échec d'AICore avec le type d'erreur 3-PREPARATION_ERROR et le code d'erreur 606-FEATURE_NOT_FOUND: la fonctionnalité ... n'est pas disponible.	Cela peut se produire lorsque AICore n'a pas terminé de télécharger les dernières configurations. Laissez la connexion réseau active et attendez quelques minutes à quelques heures. Notez que si le bootloader de l'appareil est déverrouillé, cette erreur s'affiche également. Cette API n'est pas compatible avec les appareils dont le bootloader est déverrouillé.
Échec d'AICore avec le type d'erreur 1-DOWNLOAD_ERROR et le code d'erreur 0-UNKNOWN: la fonctionnalité ... a échoué avec l'état d'échec 0 et l'erreur esz: UNAVAILABLE: Unable to resolve host ...	Laissez la connexion réseau active, patientez quelques minutes, puis réessayez.

Remarque :Les différentes réinitialisations sont courantes pour les développeurs, mais beaucoup moins pour les utilisateurs. De plus, tous ces cas de défaillance de configuration peuvent être détectés par l'API checkFeatureStatus(). Veillez à appeler checkFeatureStatus() avant d'afficher une UI associée, afin que les utilisateurs de votre application ne voient jamais ces erreurs.