uapi-browser-sdk 0.1.0

package/internal/docs/TranslateApi.md

@@ -0,0 +1,216 @@
+# TranslateApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAiTranslateLanguages**](TranslateApi.md#getaitranslatelanguages) | **GET** /ai/translate/languages | 获取AI翻译支持的语言和配置 |
+| [**postAiTranslate**](TranslateApi.md#postaitranslateoperation) | **POST** /ai/translate | AI智能翻译 |
+| [**postTranslateText**](TranslateApi.md#posttranslatetextoperation) | **POST** /translate/text | 多语言文本翻译 |
+
+
+
+## getAiTranslateLanguages
+
+> GetAiTranslateLanguages200Response getAiTranslateLanguages()
+
+获取AI翻译支持的语言和配置
+
+获取AI智能翻译服务支持的完整语言列表、翻译风格选项、上下文场景选项以及性能指标信息。这个接口对于需要在前端动态展示翻译配置选项的应用非常有用，它会返回当前AI翻译服务所支持的所有语言代码、原生名称、翻译风格说明、上下文场景描述，以及服务的性能特征和限制信息。通过此接口，开发者可以构建用户友好的翻译界面，让用户选择合适的翻译参数。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TranslateApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetAiTranslateLanguagesRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TranslateApi();
+
+  try {
+    const data = await api.getAiTranslateLanguages();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetAiTranslateLanguages200Response**](GetAiTranslateLanguages200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功获取AI翻译配置信息！ |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postAiTranslate
+
+> PostAiTranslate200Response postAiTranslate(targetLang, postAiTranslateRequest)
+
+AI智能翻译
+
+这是一个商业级的AI智能翻译服务，采用最新的神经网络翻译技术和大语言模型，提供远超传统机器翻译的质量。它不仅能够智能处理单个文本翻译，还支持高效的批量文本翻译，并且具备上下文感知、风格适配、格式保留等高级功能。  > [!VIP] > 本API目前处于**限时免费**阶段，我们鼓励开发者深度集成和测试。未来，它将转为付费API，为用户提供更稳定、更智能的翻译服务。  ## 功能概述  - **智能双模式**: 支持单个文本翻译和批量文本翻译的统一接口设计，自动识别请求类型并提供相应的翻译服务。系统会根据输入自动判断是处理单条文本还是批量文本，无需使用不同的接口。 - **多风格适配**: 提供随意口语化、专业商务、学术正式、文学艺术四种翻译风格，能够根据不同场景需求调整翻译的语言风格和表达方式。 - **上下文感知**: 支持通用、商务、技术、医疗、法律、市场营销、娱乐、教育、新闻等九种专业领域的上下文翻译，确保术语准确性和表达地道性。 - **高质量保证**: 内置质量评估系统，对每次翻译结果进行流畅度、准确度、完整性评分，并提供置信度分数和替代翻译建议。 - **智能解释**: 提供关键词组翻译注释、文化背景说明和语法结构分析，帮助用户理解翻译逻辑和文化差异。 - **高效批量**: 批量翻译支持最多50条文本，总计10万字符，配备智能并发控制（1-10并发）和失败重试机制。 - **快速模式**: 提供快速模式选项，在保证95%+准确率的前提下，响应时间缩短至800ms内，适合实时翻译和聊天应用。 - **格式保留**: 智能识别并保持原文的格式结构，包括换行、缩进、特殊符号等，确保翻译后的文本保持良好的可读性。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TranslateApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostAiTranslateOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TranslateApi();
+
+  const body = {
+    // 'sq' | 'ga' | 'et' | 'ar' | 'am' | 'az' | 'be' | 'bg' | 'eu' | 'is' | 'pl' | 'bs-Latn' | 'fa' | 'da' | 'de' | 'ru' | 'fr' | 'tl' | 'fi' | 'fy' | 'km' | 'ka' | 'gu' | 'ht' | 'ko' | 'ha' | 'kk' | 'nl' | 'gl' | 'ca' | 'cs' | 'ky' | 'kn' | 'tlh' | 'hr' | 'otq' | 'co' | 'ku' | 'la' | 'lo' | 'lv' | 'lt' | 'ro' | 'lb' | 'mg' | 'mt' | 'mr' | 'ms' | 'ml' | 'mi' | 'mk' | 'mn' | 'bn' | 'my' | 'mww' | 'hmn' | 'xh' | 'zu' | 'ne' | 'false' | 'pa' | 'ps' | 'pt' | 'ny' | 'ja' | 'sv' | 'sr-Latn' | 'sr-Cyrl' | 'st' | 'sm' | 'si' | 'eo' | 'sk' | 'sl' | 'sw' | 'gd' | 'so' | 'ceb' | 'te' | 'ta' | 'th' | 'tg' | 'tr' | 'cy' | 'zh-lzh' | 'ur' | 'uk' | 'uz' | 'haw' | 'es' | 'he' | 'el' | 'sd' | 'hu' | 'sn' | 'hy' | 'ig' | 'it' | 'yi' | 'hi' | 'id' | 'en' | 'su' | 'jw' | 'yua' | 'yo' | 'vi' | 'zh-CHS' | 'zh-CHT' | 目标语言代码。请从支持的语言列表中选择一个语言代码。
+    targetLang: zh-CHS,
+    // PostAiTranslateRequest | 包含翻译参数的JSON对象，支持单个文本或批量文本翻译
+    postAiTranslateRequest: ...,
+  } satisfies PostAiTranslateOperationRequest;
+
+  try {
+    const data = await api.postAiTranslate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **targetLang** | `sq`, `ga`, `et`, `ar`, `am`, `az`, `be`, `bg`, `eu`, `is`, `pl`, `bs-Latn`, `fa`, `da`, `de`, `ru`, `fr`, `tl`, `fi`, `fy`, `km`, `ka`, `gu`, `ht`, `ko`, `ha`, `kk`, `nl`, `gl`, `ca`, `cs`, `ky`, `kn`, `tlh`, `hr`, `otq`, `co`, `ku`, `la`, `lo`, `lv`, `lt`, `ro`, `lb`, `mg`, `mt`, `mr`, `ms`, `ml`, `mi`, `mk`, `mn`, `bn`, `my`, `mww`, `hmn`, `xh`, `zu`, `ne`, `false`, `pa`, `ps`, `pt`, `ny`, `ja`, `sv`, `sr-Latn`, `sr-Cyrl`, `st`, `sm`, `si`, `eo`, `sk`, `sl`, `sw`, `gd`, `so`, `ceb`, `te`, `ta`, `th`, `tg`, `tr`, `cy`, `zh-lzh`, `ur`, `uk`, `uz`, `haw`, `es`, `he`, `el`, `sd`, `hu`, `sn`, `hy`, `ig`, `it`, `yi`, `hi`, `id`, `en`, `su`, `jw`, `yua`, `yo`, `vi`, `zh-CHS`, `zh-CHT` | 目标语言代码。请从支持的语言列表中选择一个语言代码。 | [Defaults to `undefined`] [Enum: sq, ga, et, ar, am, az, be, bg, eu, is, pl, bs-Latn, fa, da, de, ru, fr, tl, fi, fy, km, ka, gu, ht, ko, ha, kk, nl, gl, ca, cs, ky, kn, tlh, hr, otq, co, ku, la, lo, lv, lt, ro, lb, mg, mt, mr, ms, ml, mi, mk, mn, bn, my, mww, hmn, xh, zu, ne, false, pa, ps, pt, ny, ja, sv, sr-Latn, sr-Cyrl, st, sm, si, eo, sk, sl, sw, gd, so, ceb, te, ta, th, tg, tr, cy, zh-lzh, ur, uk, uz, haw, es, he, el, sd, hu, sn, hy, ig, it, yi, hi, id, en, su, jw, yua, yo, vi, zh-CHS, zh-CHT] |
+| **postAiTranslateRequest** | [PostAiTranslateRequest](PostAiTranslateRequest.md) | 包含翻译参数的JSON对象，支持单个文本或批量文本翻译 | |
+
+### Return type
+
+[**PostAiTranslate200Response**](PostAiTranslate200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 翻译成功！返回翻译结果、质量指标和性能统计。 |  -  |
+| **400** | 请求参数错误。请检查必填参数和参数格式是否正确。 |  -  |
+| **401** | 认证失败。请检查API密钥是否有效。 |  -  |
+| **429** | 请求频率过高。请稍后重试。 |  -  |
+| **500** | 翻译服务内部错误。请稍后重试或联系技术支持。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postTranslateText
+
+> PostTranslateText200Response postTranslateText(toLang, postTranslateTextRequest)
+
+多语言文本翻译
+
+需要跨越语言的鸿沟进行交流？这个翻译接口是你可靠的\'同声传译\'。  ## 功能概述 你可以将一段源语言文本（我们能自动检测源语言）翻译成你指定的任何目标语言。无论是中译英、日译法，都不在话下。  ## 支持的语言 我们支持超过100种语言的互译，包括但不限于：中文（简体/繁体）、英语、日语、韩语、法语、德语、西班牙语、俄语、阿拉伯语等主流语言，以及各种小语种。详见下方参数列表。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TranslateApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTranslateTextOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TranslateApi();
+
+  const body = {
+    // 'sq' | 'ga' | 'et' | 'ar' | 'am' | 'az' | 'be' | 'bg' | 'eu' | 'is' | 'pl' | 'bs-Latn' | 'fa' | 'da' | 'de' | 'ru' | 'fr' | 'tl' | 'fi' | 'fy' | 'km' | 'ka' | 'gu' | 'ht' | 'ko' | 'ha' | 'kk' | 'nl' | 'gl' | 'ca' | 'cs' | 'ky' | 'kn' | 'tlh' | 'hr' | 'otq' | 'co' | 'ku' | 'la' | 'lo' | 'lv' | 'lt' | 'ro' | 'lb' | 'mg' | 'mt' | 'mr' | 'ms' | 'ml' | 'mi' | 'mk' | 'mn' | 'bn' | 'my' | 'mww' | 'hmn' | 'xh' | 'zu' | 'ne' | 'false' | 'pa' | 'ps' | 'pt' | 'ny' | 'ja' | 'sv' | 'sr-Latn' | 'sr-Cyrl' | 'st' | 'sm' | 'si' | 'eo' | 'sk' | 'sl' | 'sw' | 'gd' | 'so' | 'ceb' | 'te' | 'ta' | 'th' | 'tg' | 'tr' | 'cy' | 'zh-lzh' | 'ur' | 'uk' | 'uz' | 'haw' | 'es' | 'he' | 'el' | 'sd' | 'hu' | 'sn' | 'hy' | 'ig' | 'it' | 'yi' | 'hi' | 'id' | 'en' | 'su' | 'jw' | 'yua' | 'yo' | 'vi' | 'zh-CHS' | 'zh-CHT' | 目标语言代码。请从支持的语言列表中选择一个语言代码。
+    toLang: zh-CHS,
+    // PostTranslateTextRequest | 包含待翻译文本的JSON对象
+    postTranslateTextRequest: ...,
+  } satisfies PostTranslateTextOperationRequest;
+
+  try {
+    const data = await api.postTranslateText(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **toLang** | `sq`, `ga`, `et`, `ar`, `am`, `az`, `be`, `bg`, `eu`, `is`, `pl`, `bs-Latn`, `fa`, `da`, `de`, `ru`, `fr`, `tl`, `fi`, `fy`, `km`, `ka`, `gu`, `ht`, `ko`, `ha`, `kk`, `nl`, `gl`, `ca`, `cs`, `ky`, `kn`, `tlh`, `hr`, `otq`, `co`, `ku`, `la`, `lo`, `lv`, `lt`, `ro`, `lb`, `mg`, `mt`, `mr`, `ms`, `ml`, `mi`, `mk`, `mn`, `bn`, `my`, `mww`, `hmn`, `xh`, `zu`, `ne`, `false`, `pa`, `ps`, `pt`, `ny`, `ja`, `sv`, `sr-Latn`, `sr-Cyrl`, `st`, `sm`, `si`, `eo`, `sk`, `sl`, `sw`, `gd`, `so`, `ceb`, `te`, `ta`, `th`, `tg`, `tr`, `cy`, `zh-lzh`, `ur`, `uk`, `uz`, `haw`, `es`, `he`, `el`, `sd`, `hu`, `sn`, `hy`, `ig`, `it`, `yi`, `hi`, `id`, `en`, `su`, `jw`, `yua`, `yo`, `vi`, `zh-CHS`, `zh-CHT` | 目标语言代码。请从支持的语言列表中选择一个语言代码。 | [Defaults to `undefined`] [Enum: sq, ga, et, ar, am, az, be, bg, eu, is, pl, bs-Latn, fa, da, de, ru, fr, tl, fi, fy, km, ka, gu, ht, ko, ha, kk, nl, gl, ca, cs, ky, kn, tlh, hr, otq, co, ku, la, lo, lv, lt, ro, lb, mg, mt, mr, ms, ml, mi, mk, mn, bn, my, mww, hmn, xh, zu, ne, false, pa, ps, pt, ny, ja, sv, sr-Latn, sr-Cyrl, st, sm, si, eo, sk, sl, sw, gd, so, ceb, te, ta, th, tg, tr, cy, zh-lzh, ur, uk, uz, haw, es, he, el, sd, hu, sn, hy, ig, it, yi, hi, id, en, su, jw, yua, yo, vi, zh-CHS, zh-CHT] |
+| **postTranslateTextRequest** | [PostTranslateTextRequest](PostTranslateTextRequest.md) | 包含待翻译文本的JSON对象 | |
+
+### Return type
+
+[**PostTranslateText200Response**](PostTranslateText200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | 无效的请求体 |  -  |
+| **500** | 翻译失败 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/internal/docs/WebParseApi.md

@@ -0,0 +1,286 @@
+# WebParseApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getWebTomarkdownAsyncStatus**](WebParseApi.md#getwebtomarkdownasyncstatus) | **GET** /web/tomarkdown/async/{task_id} | 查询网页转换任务状态和结果 |
+| [**getWebparseExtractimages**](WebParseApi.md#getwebparseextractimages) | **GET** /webparse/extractimages | 提取网页中的所有图片 |
+| [**getWebparseMetadata**](WebParseApi.md#getwebparsemetadata) | **GET** /webparse/metadata | 抓取并解析网页的元数据 |
+| [**postWebTomarkdownAsync**](WebParseApi.md#postwebtomarkdownasync) | **POST** /web/tomarkdown/async | 深度抓取网页转Markdown |
+
+
+
+## getWebTomarkdownAsyncStatus
+
+> GetWebTomarkdownAsyncStatus200Response getWebTomarkdownAsyncStatus(taskId)
+
+查询网页转换任务状态和结果
+
+提交了URL转Markdown任务后，想知道处理进度和结果？这个接口可以帮你实时追踪。  ## 功能概述  通过之前提交任务时获得的任务ID，你可以查询该任务的当前状态、处理进度以及最终结果。任务结果会在缓存中保存30分钟，期间可以重复查询，非常方便。  任务有五种状态：等待处理（pending）时进度为0%；处理中（processing）时进度在10-90%之间；已完成（completed）时进度为100%并返回Markdown内容；失败（failed）时会返回错误信息；超时（timeout）表示任务处理时间超过60秒已被取消。建议采用指数退避策略进行轮询，初始延迟1秒，每次延迟增加20%，最大延迟5秒。当状态为已完成、失败或超时时停止轮询。  系统会自动管理任务生命周期，单个任务最长处理时间为60秒，任务结果保存30分钟后自动清理，每5分钟清理一次过期任务。  ## 任务状态说明  | 状态 | 说明 | 进度 | 轮询建议 | |------|------|------|----------| | `pending` | 等待处理 | 0% | 立即开始轮询 | | `processing` | 处理中 | 10-90% | 每2-5秒轮询一次 | | `completed` | 已完成 | 100% | 停止轮询，获取结果 | | `failed` | 失败 | 100% | 停止轮询，查看错误信息 | | `timeout` | 超时 | 100% | 停止轮询，任务已取消 |
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebParseApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetWebTomarkdownAsyncStatusRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new WebParseApi();
+
+  const body = {
+    // string | 任务ID（由提交接口返回）
+    taskId: a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6,
+  } satisfies GetWebTomarkdownAsyncStatusRequest;
+
+  try {
+    const data = await api.getWebTomarkdownAsyncStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` | 任务ID（由提交接口返回） | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetWebTomarkdownAsyncStatus200Response**](GetWebTomarkdownAsyncStatus200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功获取任务状态（包含各种状态的响应） |  -  |
+| **404** | 任务不存在或已过期 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWebparseExtractimages
+
+> GetWebparseExtractimages200Response getWebparseExtractimages(url)
+
+提取网页中的所有图片
+
+想一次性“打包”一个网页上的所有图片吗？这个接口可以帮你实现。  ## 功能概述 你提供一个网页的URL，我们会访问该页面，解析其HTML内容，并提取出所有 `<img>` 标签中的图片链接，然后将这些链接列表返回给你。非常适合用于制作图片采集器或素材下载工具。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebParseApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetWebparseExtractimagesRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new WebParseApi();
+
+  const body = {
+    // string | 需要提取图片的网页URL
+    url: https://cn.bing.com/,
+  } satisfies GetWebparseExtractimagesRequest;
+
+  try {
+    const data = await api.getWebparseExtractimages(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **url** | `string` | 需要提取图片的网页URL | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetWebparseExtractimages200Response**](GetWebparseExtractimages200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | URL参数缺失或无效 |  -  |
+| **500** | 服务器内部错误 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWebparseMetadata
+
+> GetWebparseMetadata200Response getWebparseMetadata(url)
+
+抓取并解析网页的元数据
+
+当你在应用中需要展示一个链接的预览时（就像微信或Telegram里那样），这个接口能帮你轻松获取所需信息。  ## 功能概述 你提供一个网页的URL，我们会抓取并解析它的 `<head>` 部分，提取出关键的元数据（Metadata），如页面标题（Title）、描述（Description）、关键词（Keywords）以及网站图标（Favicon）等。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebParseApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetWebparseMetadataRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new WebParseApi();
+
+  const body = {
+    // string | 需要提取元数据的网页URL
+    url: https://www.bilibili.com,
+  } satisfies GetWebparseMetadataRequest;
+
+  try {
+    const data = await api.getWebparseMetadata(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **url** | `string` | 需要提取元数据的网页URL | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetWebparseMetadata200Response**](GetWebparseMetadata200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 成功响应 |  -  |
+| **400** | URL参数缺失或无效 |  -  |
+| **500** | 服务器内部错误 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postWebTomarkdownAsync
+
+> PostWebTomarkdownAsync202Response postWebTomarkdownAsync(url)
+
+深度抓取网页转Markdown
+
+想要将复杂的网页转换为结构清晰的Markdown？这个接口采用异步处理模式，特别适合处理大型网页、复杂网站或需要长时间处理的转换任务。  ## 功能概述  > [!VIP] >本API目前处于**限时免费**阶段，我们鼓励开发者集成和测试。未来，它将转为付费API，为用户提供更稳定和强大的服务。  UAPI Pro平台推出的异步网页转Markdown API能够将任意网页URL转换为结构清晰、格式优美的Markdown文本。提交任务后立即返回任务ID，不会阻塞客户端等待。您可以通过任务ID实时查询转换进度和处理状态，支持长达60秒的处理时间，轻松应对大型网站、需要JS渲染的单页应用等复杂页面。任务结果会缓存30分钟，期间可重复查询，过期任务自动清理无需手动管理。  此API采用先进算法，自动识别并抓取网页主体内容，精准剔除广告、导航栏、页眉页脚等无关元素。完美保留原文的格式，包括标题、列表、代码块、表格、引用、图片等，并输出为兼容性强的GitHub Flavored Markdown (GFM) 格式。同时会自动解析并提取文章标题、作者、发布日期、站点名称等关键元数据，并将其格式化为标准的YAML Front Matter，方便后续处理和CMS集成。  ## 使用流程  调用本接口提交URL转换任务后，会立即获得一个唯一的任务ID。随后使用任务ID调用查询接口，获取任务状态和进度。任务完成后，从查询接口的响应中获取Markdown内容。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebParseApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostWebTomarkdownAsyncRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new WebParseApi();
+
+  const body = {
+    // string | 需要转换的网页URL。URL必须经过编码。
+    url: https://example.com,
+  } satisfies PostWebTomarkdownAsyncRequest;
+
+  try {
+    const data = await api.postWebTomarkdownAsync(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **url** | `string` | 需要转换的网页URL。URL必须经过编码。 | [Defaults to `undefined`] |
+
+### Return type
+
+[**PostWebTomarkdownAsync202Response**](PostWebTomarkdownAsync202Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | 任务已提交成功，返回任务ID |  -  |
+| **400** | 请求参数错误 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/internal/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "uapi-browser-sdk-browser",
+  "version": "1.0.0",
+  "description": "OpenAPI client for uapi-browser-sdk-browser",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}