uapi-browser-sdk 0.1.1 → 0.1.3

package/internal/docs/PostTranslateStream500Response.md

@@ -0,0 +1,36 @@
+
+# PostTranslateStream500Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`code` | string
+
+## Example
+
+```typescript
+import type { PostTranslateStream500Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": Translation service unavailable,
+  "code": SERVICE_ERROR,
+} satisfies PostTranslateStream500Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostTranslateStream500Response
+console.log(exampleParsed)
+```
+
+[[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/PostTranslateStreamRequest.md

@@ -0,0 +1,40 @@
+
+# PostTranslateStreamRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`query` | string
+`toLang` | string
+`fromLang` | string
+`tone` | string
+
+## Example
+
+```typescript
+import type { PostTranslateStreamRequest } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "query": Hello, how are you?,
+  "toLang": 中文,
+  "fromLang": 英文,
+  "tone": ,
+} satisfies PostTranslateStreamRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostTranslateStreamRequest
+console.log(exampleParsed)
+```
+
+[[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/TranslateApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://uapis.cn/api/v1*
 |------------- | ------------- | -------------|
 | [**getAiTranslateLanguages**](TranslateApi.md#getaitranslatelanguages) | **GET** /ai/translate/languages | 获取AI翻译支持的语言和配置 |
 | [**postAiTranslate**](TranslateApi.md#postaitranslateoperation) | **POST** /ai/translate | AI智能翻译 |
+| [**postTranslateStream**](TranslateApi.md#posttranslatestreamoperation) | **POST** /translate/stream | 流式翻译（中英互译） |
 | [**postTranslateText**](TranslateApi.md#posttranslatetextoperation) | **POST** /translate/text | 多语言文本翻译 |
 
 
@@ -143,6 +144,75 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## postTranslateStream
+
+> string postTranslateStream(postTranslateStreamRequest)
+
+流式翻译（中英互译）
+
+想让翻译结果像打字机一样逐字显示出来？这个流式翻译接口能实现这种效果。  ## 功能概述 不同于传统翻译API一次性返回完整结果，这个接口会实时地、一个字一个字地把翻译内容推给你（就像ChatGPT回复消息那样），非常适合用在聊天应用、直播字幕等需要即时反馈的场景。  ## 它能做什么 - **中英互译**：支持中文和英文之间的双向翻译 - **自动识别**：不确定源语言？设置为 `auto` 让我们自动检测 - **逐字返回**：翻译结果会像打字机一样逐字流式返回，用户体验更流畅 - **音频朗读**：部分翻译结果会附带音频链接，方便朗读  ## 支持的语言 目前专注于中英互译，支持以下选项： - `中文`（简体/繁体） - `英文` - `auto`（自动检测）
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TranslateApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostTranslateStreamOperationRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new TranslateApi();
+
+  const body = {
+    // PostTranslateStreamRequest | 包含翻译参数的JSON对象
+    postTranslateStreamRequest: ...,
+  } satisfies PostTranslateStreamOperationRequest;
+
+  try {
+    const data = await api.postTranslateStream(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postTranslateStreamRequest** | [PostTranslateStreamRequest](PostTranslateStreamRequest.md) | 包含翻译参数的JSON对象 | |
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `text/event-stream`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | SSE流式响应。Content-Type为text/event-stream |  -  |
+| **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)
+
+
 ## postTranslateText
 
 > PostTranslateText200Response postTranslateText(toLang, postTranslateTextRequest)

package/internal/src/apis/TranslateApi.ts

@@ -22,6 +22,9 @@ import type {
   PostAiTranslate429Response,
   PostAiTranslate500Response,
   PostAiTranslateRequest,
+  PostTranslateStream400Response,
+  PostTranslateStream500Response,
+  PostTranslateStreamRequest,
   PostTranslateText200Response,
   PostTranslateText400Response,
   PostTranslateText500Response,
@@ -42,6 +45,12 @@ import {
     PostAiTranslate500ResponseToJSON,
     PostAiTranslateRequestFromJSON,
     PostAiTranslateRequestToJSON,
+    PostTranslateStream400ResponseFromJSON,
+    PostTranslateStream400ResponseToJSON,
+    PostTranslateStream500ResponseFromJSON,
+    PostTranslateStream500ResponseToJSON,
+    PostTranslateStreamRequestFromJSON,
+    PostTranslateStreamRequestToJSON,
     PostTranslateText200ResponseFromJSON,
     PostTranslateText200ResponseToJSON,
     PostTranslateText400ResponseFromJSON,
@@ -57,6 +66,10 @@ export interface PostAiTranslateOperationRequest {
     postAiTranslateRequest: PostAiTranslateRequest;
 }
 
+export interface PostTranslateStreamOperationRequest {
+    postTranslateStreamRequest: PostTranslateStreamRequest;
+}
+
 export interface PostTranslateTextOperationRequest {
     toLang: PostTranslateTextOperationToLangEnum;
     postTranslateTextRequest: PostTranslateTextRequest;
@@ -150,6 +163,51 @@ export class TranslateApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * 想让翻译结果像打字机一样逐字显示出来？这个流式翻译接口能实现这种效果。  ## 功能概述 不同于传统翻译API一次性返回完整结果，这个接口会实时地、一个字一个字地把翻译内容推给你（就像ChatGPT回复消息那样），非常适合用在聊天应用、直播字幕等需要即时反馈的场景。  ## 它能做什么 - **中英互译**：支持中文和英文之间的双向翻译 - **自动识别**：不确定源语言？设置为 `auto` 让我们自动检测 - **逐字返回**：翻译结果会像打字机一样逐字流式返回，用户体验更流畅 - **音频朗读**：部分翻译结果会附带音频链接，方便朗读  ## 支持的语言 目前专注于中英互译，支持以下选项： - `中文`（简体/繁体） - `英文` - `auto`（自动检测）
+     * 流式翻译（中英互译）
+     */
+    async postTranslateStreamRaw(requestParameters: PostTranslateStreamOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        if (requestParameters['postTranslateStreamRequest'] == null) {
+            throw new runtime.RequiredError(
+                'postTranslateStreamRequest',
+                'Required parameter "postTranslateStreamRequest" was null or undefined when calling postTranslateStream().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/translate/stream`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostTranslateStreamRequestToJSON(requestParameters['postTranslateStreamRequest']),
+        }, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * 想让翻译结果像打字机一样逐字显示出来？这个流式翻译接口能实现这种效果。  ## 功能概述 不同于传统翻译API一次性返回完整结果，这个接口会实时地、一个字一个字地把翻译内容推给你（就像ChatGPT回复消息那样），非常适合用在聊天应用、直播字幕等需要即时反馈的场景。  ## 它能做什么 - **中英互译**：支持中文和英文之间的双向翻译 - **自动识别**：不确定源语言？设置为 `auto` 让我们自动检测 - **逐字返回**：翻译结果会像打字机一样逐字流式返回，用户体验更流畅 - **音频朗读**：部分翻译结果会附带音频链接，方便朗读  ## 支持的语言 目前专注于中英互译，支持以下选项： - `中文`（简体/繁体） - `英文` - `auto`（自动检测）
+     * 流式翻译（中英互译）
+     */
+    async postTranslateStream(requestParameters: PostTranslateStreamOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.postTranslateStreamRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * 需要跨越语言的鸿沟进行交流？这个翻译接口是你可靠的\'同声传译\'。  ## 功能概述 你可以将一段源语言文本（我们能自动检测源语言）翻译成你指定的任何目标语言。无论是中译英、日译法，都不在话下。  ## 支持的语言 我们支持超过100种语言的互译，包括但不限于：中文（简体/繁体）、英语、日语、韩语、法语、德语、西班牙语、俄语、阿拉伯语等主流语言，以及各种小语种。详见下方参数列表。
      * 多语言文本翻译

package/internal/src/models/PostTranslateStream400Response.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UAPI
+ * UAPI 官方接口文档
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostTranslateStream400Response
+ */
+export interface PostTranslateStream400Response {
+    /**
+     * 错误描述
+     * @type {string}
+     * @memberof PostTranslateStream400Response
+     */
+    error?: string;
+    /**
+     * 错误码
+     * @type {string}
+     * @memberof PostTranslateStream400Response
+     */
+    code?: PostTranslateStream400ResponseCodeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostTranslateStream400ResponseCodeEnum = {
+    InvalidRequest: 'INVALID_REQUEST',
+    MissingQuery: 'MISSING_QUERY',
+    MissingTargetLang: 'MISSING_TARGET_LANG'
+} as const;
+export type PostTranslateStream400ResponseCodeEnum = typeof PostTranslateStream400ResponseCodeEnum[keyof typeof PostTranslateStream400ResponseCodeEnum];
+
+
+/**
+ * Check if a given object implements the PostTranslateStream400Response interface.
+ */
+export function instanceOfPostTranslateStream400Response(value: object): value is PostTranslateStream400Response {
+    return true;
+}
+
+export function PostTranslateStream400ResponseFromJSON(json: any): PostTranslateStream400Response {
+    return PostTranslateStream400ResponseFromJSONTyped(json, false);
+}
+
+export function PostTranslateStream400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostTranslateStream400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': json['error'] == null ? undefined : json['error'],
+        'code': json['code'] == null ? undefined : json['code'],
+    };
+}
+
+export function PostTranslateStream400ResponseToJSON(json: any): PostTranslateStream400Response {
+    return PostTranslateStream400ResponseToJSONTyped(json, false);
+}
+
+export function PostTranslateStream400ResponseToJSONTyped(value?: PostTranslateStream400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': value['error'],
+        'code': value['code'],
+    };
+}
+

package/internal/src/models/PostTranslateStream500Response.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UAPI
+ * UAPI 官方接口文档
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostTranslateStream500Response
+ */
+export interface PostTranslateStream500Response {
+    /**
+     * 错误描述
+     * @type {string}
+     * @memberof PostTranslateStream500Response
+     */
+    error?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostTranslateStream500Response
+     */
+    code?: string;
+}
+
+/**
+ * Check if a given object implements the PostTranslateStream500Response interface.
+ */
+export function instanceOfPostTranslateStream500Response(value: object): value is PostTranslateStream500Response {
+    return true;
+}
+
+export function PostTranslateStream500ResponseFromJSON(json: any): PostTranslateStream500Response {
+    return PostTranslateStream500ResponseFromJSONTyped(json, false);
+}
+
+export function PostTranslateStream500ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostTranslateStream500Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': json['error'] == null ? undefined : json['error'],
+        'code': json['code'] == null ? undefined : json['code'],
+    };
+}
+
+export function PostTranslateStream500ResponseToJSON(json: any): PostTranslateStream500Response {
+    return PostTranslateStream500ResponseToJSONTyped(json, false);
+}
+
+export function PostTranslateStream500ResponseToJSONTyped(value?: PostTranslateStream500Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': value['error'],
+        'code': value['code'],
+    };
+}
+

package/internal/src/models/PostTranslateStreamRequest.ts

@@ -0,0 +1,112 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UAPI
+ * UAPI 官方接口文档
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostTranslateStreamRequest
+ */
+export interface PostTranslateStreamRequest {
+    /**
+     * 待翻译的文本内容
+     * @type {string}
+     * @memberof PostTranslateStreamRequest
+     */
+    query: string;
+    /**
+     * 目标语言，支持：中文、英文
+     * @type {string}
+     * @memberof PostTranslateStreamRequest
+     */
+    toLang: PostTranslateStreamRequestToLangEnum;
+    /**
+     * 源语言，支持：中文、英文、auto（自动检测）。默认为auto
+     * @type {string}
+     * @memberof PostTranslateStreamRequest
+     */
+    fromLang?: PostTranslateStreamRequestFromLangEnum;
+    /**
+     * 语气参数，可选
+     * @type {string}
+     * @memberof PostTranslateStreamRequest
+     */
+    tone?: string;
+}
+
+
+/**
+ * @export
+ */
+export const PostTranslateStreamRequestToLangEnum = {
+    : '中文',
+    2: '英文'
+} as const;
+export type PostTranslateStreamRequestToLangEnum = typeof PostTranslateStreamRequestToLangEnum[keyof typeof PostTranslateStreamRequestToLangEnum];
+
+/**
+ * @export
+ */
+export const PostTranslateStreamRequestFromLangEnum = {
+    : '中文',
+    2: '英文',
+    Auto: 'auto'
+} as const;
+export type PostTranslateStreamRequestFromLangEnum = typeof PostTranslateStreamRequestFromLangEnum[keyof typeof PostTranslateStreamRequestFromLangEnum];
+
+
+/**
+ * Check if a given object implements the PostTranslateStreamRequest interface.
+ */
+export function instanceOfPostTranslateStreamRequest(value: object): value is PostTranslateStreamRequest {
+    if (!('query' in value) || value['query'] === undefined) return false;
+    if (!('toLang' in value) || value['toLang'] === undefined) return false;
+    return true;
+}
+
+export function PostTranslateStreamRequestFromJSON(json: any): PostTranslateStreamRequest {
+    return PostTranslateStreamRequestFromJSONTyped(json, false);
+}
+
+export function PostTranslateStreamRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostTranslateStreamRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'query': json['query'],
+        'toLang': json['to_lang'],
+        'fromLang': json['from_lang'] == null ? undefined : json['from_lang'],
+        'tone': json['tone'] == null ? undefined : json['tone'],
+    };
+}
+
+export function PostTranslateStreamRequestToJSON(json: any): PostTranslateStreamRequest {
+    return PostTranslateStreamRequestToJSONTyped(json, false);
+}
+
+export function PostTranslateStreamRequestToJSONTyped(value?: PostTranslateStreamRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'query': value['query'],
+        'to_lang': value['toLang'],
+        'from_lang': value['fromLang'],
+        'tone': value['tone'],
+    };
+}
+

package/internal/src/models/index.ts

@@ -252,6 +252,9 @@ export * from './PostTextMd5Request';
 export * from './PostTextMd5Verify200Response';
 export * from './PostTextMd5Verify400Response';
 export * from './PostTextMd5VerifyRequest';
+export * from './PostTranslateStream400Response';
+export * from './PostTranslateStream500Response';
+export * from './PostTranslateStreamRequest';
 export * from './PostTranslateText200Response';
 export * from './PostTranslateText400Response';
 export * from './PostTranslateText500Response';

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "uapi-browser-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "scripts": { "build": "tsc -p tsconfig.json" },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
   "devDependencies": {
     "typescript": "^5.4.0"
   }