@mediapipe/tasks-text 0.10.4 → 0.10.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediapipe/tasks-text",
-  "version": "0.10.4",
+  "version": "0.10.6",
   "description": "MediaPipe Text Tasks",
   "main": "text_bundle.cjs",
   "browser": "text_bundle.mjs",
@@ -8,7 +8,8 @@
   "exports": {
     "import":  "./text_bundle.mjs",
     "require": "./text_bundle.cjs",
-    "default":  "./text_bundle.mjs"
+    "default":  "./text_bundle.mjs",
+    "types":  "./text_.d.ts"
   },
   "author": "mediapipe@google.com",
   "license": "Apache-2.0",

package/text.d.ts

@@ -221,12 +221,14 @@ export declare class FilesetResolver {
      * you can use `isSimdSupported()` to decide whether to load the SIMD-based
      * assets.
      *
+     * @export
      * @return Whether SIMD support was detected in the current environment.
      */
     static isSimdSupported(): Promise<boolean>;
     /**
      * Creates a fileset for the MediaPipe Audio tasks.
      *
+     * @export
      * @param basePath An optional base path to specify the directory the Wasm
      *    files should be loaded from. If not specified, the Wasm files are
      *    loaded from the host's root directory.
@@ -237,6 +239,7 @@ export declare class FilesetResolver {
     /**
      * Creates a fileset for the MediaPipe Text tasks.
      *
+     * @export
      * @param basePath An optional base path to specify the directory the Wasm
      *    files should be loaded from. If not specified, the Wasm files are
      *    loaded from the host's root directory.
@@ -247,6 +250,7 @@ export declare class FilesetResolver {
     /**
      * Creates a fileset for the MediaPipe Vision tasks.
      *
+     * @export
      * @param basePath An optional base path to specify the directory the Wasm
      *    files should be loaded from. If not specified, the Wasm files are
      *    loaded from the host's root directory.
@@ -261,6 +265,7 @@ export declare class LanguageDetector extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new language detector from the
      * provided options.
+     * @export
      * @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
@@ -271,6 +276,7 @@ export declare class LanguageDetector extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new language detector based on
      * the provided model asset buffer.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetBuffer A binary representation of the model.
@@ -279,6 +285,7 @@ export declare class LanguageDetector extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new language detector based on
      * the path to the model asset.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetPath The path to the model asset.
@@ -292,12 +299,14 @@ export declare class LanguageDetector extends TaskRunner {
      * You can reset an option back to its default value by explicitly setting it
      * to `undefined`.
      *
+     * @export
      * @param options The options for the language detector.
      */
     setOptions(options: LanguageDetectorOptions): Promise<void>;
     /**
      * Predicts the language of the input text.
      *
+     * @export
      * @param text The text to process.
      * @return The languages detected in the input text.
      */
@@ -345,7 +354,10 @@ declare abstract class TaskRunner {
     protected constructor();
     /** Configures the task with custom options. */
     abstract setOptions(options: TaskRunnerOptions): Promise<void>;
-    /** Closes and cleans up the resources held by this task. */
+    /**
+     * Closes and cleans up the resources held by this task.
+     * @export
+     */
     close(): void;
 }
 
@@ -360,6 +372,7 @@ export declare class TextClassifier extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new text classifier from the
      * provided options.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param textClassifierOptions The options for the text classifier. Note that
@@ -370,6 +383,7 @@ export declare class TextClassifier extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new text classifier based on the
      * provided model asset buffer.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetBuffer A binary representation of the model.
@@ -378,6 +392,7 @@ export declare class TextClassifier extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new text classifier based on the
      * path to the model asset.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetPath The path to the model asset.
@@ -391,6 +406,7 @@ export declare class TextClassifier extends TaskRunner {
      * You can reset an option back to its default value by explicitly setting it
      * to `undefined`.
      *
+     * @export
      * @param options The options for the text classifier.
      */
     setOptions(options: TextClassifierOptions): Promise<void>;
@@ -398,6 +414,7 @@ export declare class TextClassifier extends TaskRunner {
      * Performs Natural Language classification on the provided text and waits
      * synchronously for the response.
      *
+     * @export
      * @param text The text to process.
      * @return The classification result of the text
      */
@@ -431,6 +448,7 @@ export declare class TextEmbedder extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new text embedder from the
      * provided options.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param textEmbedderOptions The options for the text embedder. Note that
@@ -441,6 +459,7 @@ export declare class TextEmbedder extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new text embedder based on the
      * provided model asset buffer.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetBuffer A binary representation of the TFLite model.
@@ -449,6 +468,7 @@ export declare class TextEmbedder extends TaskRunner {
     /**
      * Initializes the Wasm runtime and creates a new text embedder based on the
      * path to the model asset.
+     * @export
      * @param wasmFileset A configuration object that provides the location of the
      *     Wasm binary and its loader.
      * @param modelAssetPath The path to the TFLite model.
@@ -462,6 +482,7 @@ export declare class TextEmbedder extends TaskRunner {
      * You can reset an option back to its default value by explicitly setting it
      * to `undefined`.
      *
+     * @export
      * @param options The options for the text embedder.
      */
     setOptions(options: TextEmbedderOptions): Promise<void>;
@@ -469,6 +490,7 @@ export declare class TextEmbedder extends TaskRunner {
      * Performs embeding extraction on the provided text and waits synchronously
      * for the response.
      *
+     * @export
      * @param text The text to process.
      * @return The embedding resuls of the text
      */
@@ -479,6 +501,7 @@ export declare class TextEmbedder extends TaskRunner {
      *
      * [1]: https://en.wikipedia.org/wiki/Cosine_similarity
      *
+     * @export
      * @throws if the embeddings are of different types(float vs. quantized), have
      *     different sizes, or have an L2-norm of 0.
      */
@@ -530,6 +553,8 @@ declare interface WasmFileset {
     wasmBinaryPath: string;
     /** The optional path to the asset loader script. */
     assetLoaderPath?: string;
+    /** The optional path to the assets binary. */
+    assetBinaryPath?: string;
 }
 
 export { }