@capacitor-mlkit/genai-rewriting 8.1.0

package/dist/docs.json

@@ -0,0 +1,589 @@
+{
+  "api": {
+    "name": "GenAiRewritingPlugin",
+    "slug": "genairewritingplugin",
+    "docs": "",
+    "tags": [
+      {
+        "text": "8.2.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "checkFeatureStatus",
+        "signature": "(options?: FeatureOptions | undefined) => Promise<CheckFeatureStatusResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "FeatureOptions | undefined"
+          }
+        ],
+        "returns": "Promise<CheckFeatureStatusResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Check the current availability status of the rewriting feature.\n\nIf the status is `DOWNLOADABLE`, you can download the feature\nusing `downloadFeature(...)`.\n\nOnly available on Android.",
+        "complexTypes": [
+          "CheckFeatureStatusResult",
+          "FeatureOptions"
+        ],
+        "slug": "checkfeaturestatus"
+      },
+      {
+        "name": "downloadFeature",
+        "signature": "(options?: FeatureOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "FeatureOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Download the rewriting feature.\n\nThe `downloadProgress` event listener will notify you about\nthe download progress. The returned promise resolves when\nthe download is complete or the feature is already available.\n\nOnly available on Android.",
+        "complexTypes": [
+          "FeatureOptions"
+        ],
+        "slug": "downloadfeature"
+      },
+      {
+        "name": "rewrite",
+        "signature": "(options: RewriteOptions) => Promise<RewriteResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RewriteOptions"
+          }
+        ],
+        "returns": "Promise<RewriteResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Rewrite the given text in the configured style.\n\nThe `inferenceProgress` event listener will notify you about\npartial results as they are generated. The returned promise\nresolves with the full result.\n\nOnly available on Android.",
+        "complexTypes": [
+          "RewriteResult",
+          "RewriteOptions"
+        ],
+        "slug": "rewrite"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'downloadProgress', listenerFunc: (event: DownloadProgressEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'downloadProgress'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: DownloadProgressEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Called while the rewriting feature is being downloaded.\n\nOnly available on Android.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DownloadProgressEvent"
+        ],
+        "slug": "addlistenerdownloadprogress-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'inferenceProgress', listenerFunc: (event: InferenceProgressEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'inferenceProgress'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: InferenceProgressEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Called when a new partial result is available during inference.\n\nOnly available on Android.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "InferenceProgressEvent"
+        ],
+        "slug": "addlistenerinferenceprogress-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.2.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "CheckFeatureStatusResult",
+      "slug": "checkfeaturestatusresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "featureStatus",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "'AVAILABLE'",
+              "name": "example"
+            }
+          ],
+          "docs": "The current availability status of the rewriting feature.",
+          "complexTypes": [
+            "FeatureStatus"
+          ],
+          "type": "FeatureStatus"
+        }
+      ]
+    },
+    {
+      "name": "FeatureOptions",
+      "slug": "featureoptions",
+      "docs": "The feature availability depends on the configured output type\nand language. Therefore, `checkFeatureStatus(...)` and\n`downloadFeature(...)` take the same base options as `rewrite(...)`.",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "language",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "Language.English",
+              "name": "default"
+            }
+          ],
+          "docs": "The language of the input text.",
+          "complexTypes": [
+            "Language"
+          ],
+          "type": "Language"
+        },
+        {
+          "name": "outputType",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "OutputType.Elaborate",
+              "name": "default"
+            }
+          ],
+          "docs": "The style in which the input text should be rewritten.",
+          "complexTypes": [
+            "OutputType"
+          ],
+          "type": "OutputType"
+        }
+      ]
+    },
+    {
+      "name": "RewriteResult",
+      "slug": "rewriteresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "results",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "['Capacitor is an open source native runtime for building Web Native apps.']",
+              "name": "example"
+            }
+          ],
+          "docs": "The rewritten text suggestions, sorted in descending order of confidence.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
+    {
+      "name": "RewriteOptions",
+      "slug": "rewriteoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "text",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "'Capacitor is an open source native runtime for building Web Native apps.'",
+              "name": "example"
+            }
+          ],
+          "docs": "The text to rewrite.\n\nThe input must be under 256 tokens.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "DownloadProgressEvent",
+      "slug": "downloadprogressevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "totalBytesDownloaded",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "1024",
+              "name": "example"
+            }
+          ],
+          "docs": "The total number of bytes downloaded so far.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "InferenceProgressEvent",
+      "slug": "inferenceprogressevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "8.2.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "text",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            },
+            {
+              "text": "'Capacitor is an open source native runtime.'",
+              "name": "example"
+            }
+          ],
+          "docs": "The new text of the partial result.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "FeatureStatus",
+      "slug": "featurestatus",
+      "members": [
+        {
+          "name": "Available",
+          "value": "'AVAILABLE'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The feature is available to use."
+        },
+        {
+          "name": "Downloadable",
+          "value": "'DOWNLOADABLE'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The feature can be downloaded using `downloadFeature(...)`."
+        },
+        {
+          "name": "Downloading",
+          "value": "'DOWNLOADING'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The feature is currently being downloaded."
+        },
+        {
+          "name": "Unavailable",
+          "value": "'UNAVAILABLE'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The feature is not available on this device."
+        }
+      ]
+    },
+    {
+      "name": "Language",
+      "slug": "language",
+      "members": [
+        {
+          "name": "English",
+          "value": "'ENGLISH'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        },
+        {
+          "name": "French",
+          "value": "'FRENCH'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        },
+        {
+          "name": "German",
+          "value": "'GERMAN'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        },
+        {
+          "name": "Italian",
+          "value": "'ITALIAN'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        },
+        {
+          "name": "Japanese",
+          "value": "'JAPANESE'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        },
+        {
+          "name": "Korean",
+          "value": "'KOREAN'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        },
+        {
+          "name": "Spanish",
+          "value": "'SPANISH'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "OutputType",
+      "slug": "outputtype",
+      "members": [
+        {
+          "name": "Elaborate",
+          "value": "'ELABORATE'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Elaborate the input text."
+        },
+        {
+          "name": "Emojify",
+          "value": "'EMOJIFY'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Insert appropriate emojis into the input text."
+        },
+        {
+          "name": "Shorten",
+          "value": "'SHORTEN'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Shorten the input text."
+        },
+        {
+          "name": "Friendly",
+          "value": "'FRIENDLY'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Make the input text more friendly."
+        },
+        {
+          "name": "Professional",
+          "value": "'PROFESSIONAL'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Make the input text more professional."
+        },
+        {
+          "name": "Rephrase",
+          "value": "'REPHRASE'",
+          "tags": [
+            {
+              "text": "8.2.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Rephrase the input text."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}