@mediapipe/tasks-text 0.1.0-alpha-7 → 0.1.0-alpha-9

package/README.md

@@ -2,9 +2,23 @@
 
 This package contains the text tasks for MediaPipe.
 
+## Language Detection
+
+The MediaPipe Language Detector task predicts the language of an input text.
+
+```
+const text = await FilesetResolver.forTextTasks(
+    "https://cdn.jsdelivr.net/npm/@mediapipe/tasks-text@latest/wasm"
+);
+const languageDetector = await LanguageDetector.createFromModelPath(text,
+    "model.tflite"
+);
+const result = languageDetector.detect(textData);
+```
+
 ## Text Classification
 
-MediaPipe Text Classifier task lets you classify text into a set of defined
+The MediaPipe Text Classifier task lets you classify text into a set of defined
 categories, such as positive or negative sentiment.
 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediapipe/tasks-text",
-  "version": "0.1.0-alpha-7",
+  "version": "0.1.0-alpha-9",
   "description": "MediaPipe Text Tasks",
   "main": "text_bundle.js",
   "author": "mediapipe@google.com",

package/text.d.ts

@@ -256,6 +256,90 @@ export declare class FilesetResolver {
     static forVisionTasks(basePath?: string): Promise<WasmFileset>;
 }
 
+/** Predicts the language of an input text. */
+export declare class LanguageDetector extends TaskRunner {
+    /**
+     * Initializes the Wasm runtime and creates a new language detector from the
+     * provided options.
+     * @param wasmFileset A configuration object that provides the location of the
+     *     Wasm binary and its loader.
+     * @param textClassifierOptions The options for the language detector. Note
+     *     that either a path to the TFLite model or the model itself needs to be
+     *     provided (via `baseOptions`).
+     */
+    static createFromOptions(wasmFileset: WasmFileset, textClassifierOptions: LanguageDetectorOptions): Promise<LanguageDetector>;
+    /**
+     * Initializes the Wasm runtime and creates a new language detector based on
+     * the provided model asset buffer.
+     * @param wasmFileset A configuration object that provides the location of the
+     *     Wasm binary and its loader.
+     * @param modelAssetBuffer A binary representation of the model.
+     */
+    static createFromModelBuffer(wasmFileset: WasmFileset, modelAssetBuffer: Uint8Array): Promise<LanguageDetector>;
+    /**
+     * Initializes the Wasm runtime and creates a new language detector based on
+     * the path to the model asset.
+     * @param wasmFileset A configuration object that provides the location of the
+     *     Wasm binary and its loader.
+     * @param modelAssetPath The path to the model asset.
+     */
+    static createFromModelPath(wasmFileset: WasmFileset, modelAssetPath: string): Promise<LanguageDetector>;
+    private constructor();
+    /**
+     * Sets new options for the language detector.
+     *
+     * Calling `setOptions()` with a subset of options only affects those options.
+     * You can reset an option back to its default value by explicitly setting it
+     * to `undefined`.
+     *
+     * @param options The options for the language detector.
+     */
+    setOptions(options: LanguageDetectorOptions): Promise<void>;
+    /**
+     * Predicts the language of the input text.
+     *
+     * @param text The text to process.
+     * @return The languages detected in the input text.
+     */
+    detect(text: string): LanguageDetectorResult;
+}
+
+/** Options to configure the MediaPipe Language Detector Task */
+export declare interface LanguageDetectorOptions extends ClassifierOptions, TaskRunnerOptions {
+}
+
+/**
+ * Copyright 2022 The MediaPipe Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/** A language code and its probability. */
+export declare interface LanguageDetectorPrediction {
+    /**
+     * An i18n language / locale code, e.g. "en" for English, "uz" for Uzbek,
+     * "ja"-Latn for Japanese (romaji).
+     */
+    languageCode: string;
+    /** The probability */
+    probability: number;
+}
+
+/** The result of language detection. */
+export declare interface LanguageDetectorResult {
+    /** A list of language predictions. */
+    languages: LanguageDetectorPrediction[];
+}
+
 /** Base class for all MediaPipe Tasks. */
 declare abstract class TaskRunner {
     protected constructor();