uapi-browser-sdk 0.1.0

package/internal/docs/PoemApi.md

@@ -0,0 +1,69 @@
+# PoemApi
+
+All URIs are relative to *https://uapis.cn/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSaying**](PoemApi.md#getsaying) | **GET** /saying | 随机获取一句诗词或名言 |
+
+
+
+## getSaying
+
+> GetSaying200Response getSaying()
+
+随机获取一句诗词或名言
+
+想在你的应用里每天展示一句不一样的话，给用户一点小小的惊喜吗？这个“一言”接口就是为此而生。  ## 功能概述 每次调用，它都会从我们精心收集的、包含数千条诗词、动漫台词、名人名言的语料库中，随机返回一条。你可以用它来做网站首页的Slogan、应用的启动语，或者任何需要灵感点缀的地方。
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PoemApi,
+} from 'uapi-browser-sdk-browser';
+import type { GetSayingRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new PoemApi();
+
+  try {
+    const data = await api.getSaying();
+    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
+
+[**GetSaying200Response**](GetSaying200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 请求成功！返回一条随机的语录。 |  -  |
+| **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/PostAiTranslate200Response.md

@@ -0,0 +1,48 @@
+
+# PostAiTranslate200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`message` | string
+`isBatch` | boolean
+`data` | [PostAiTranslate200ResponseData](PostAiTranslate200ResponseData.md)
+`batchData` | [Array<PostAiTranslate200ResponseBatchDataInner>](PostAiTranslate200ResponseBatchDataInner.md)
+`batchSummary` | [PostAiTranslate200ResponseBatchSummary](PostAiTranslate200ResponseBatchSummary.md)
+`performance` | [PostAiTranslate200ResponsePerformance](PostAiTranslate200ResponsePerformance.md)
+`qualityMetrics` | [PostAiTranslate200ResponseQualityMetrics](PostAiTranslate200ResponseQualityMetrics.md)
+
+## Example
+
+```typescript
+import type { PostAiTranslate200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "message": Translation completed successfully,
+  "isBatch": false,
+  "data": null,
+  "batchData": null,
+  "batchSummary": null,
+  "performance": null,
+  "qualityMetrics": null,
+} satisfies PostAiTranslate200Response
+
+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 PostAiTranslate200Response
+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/PostAiTranslate200ResponseBatchDataInner.md

@@ -0,0 +1,38 @@
+
+# PostAiTranslate200ResponseBatchDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`originalText` | string
+`translatedText` | string
+`confidenceScore` | number
+
+## Example
+
+```typescript
+import type { PostAiTranslate200ResponseBatchDataInner } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "originalText": null,
+  "translatedText": null,
+  "confidenceScore": null,
+} satisfies PostAiTranslate200ResponseBatchDataInner
+
+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 PostAiTranslate200ResponseBatchDataInner
+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/PostAiTranslate200ResponseBatchSummary.md

@@ -0,0 +1,41 @@
+
+# PostAiTranslate200ResponseBatchSummary
+
+批量翻译汇总信息，仅在批量翻译时返回。
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalItems` | number
+`successItems` | number
+`failedItems` | number
+`averageQuality` | number
+
+## Example
+
+```typescript
+import type { PostAiTranslate200ResponseBatchSummary } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalItems": null,
+  "successItems": null,
+  "failedItems": null,
+  "averageQuality": null,
+} satisfies PostAiTranslate200ResponseBatchSummary
+
+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 PostAiTranslate200ResponseBatchSummary
+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/PostAiTranslate200ResponseData.md

@@ -0,0 +1,45 @@
+
+# PostAiTranslate200ResponseData
+
+单个翻译的详细结果，仅在单个翻译时返回。
+
+## Properties
+
+Name | Type
+------------ | -------------
+`originalText` | string
+`translatedText` | string
+`detectedLang` | string
+`confidenceScore` | number
+`alternatives` | Array<string>
+`explanation` | [PostAiTranslate200ResponseDataExplanation](PostAiTranslate200ResponseDataExplanation.md)
+
+## Example
+
+```typescript
+import type { PostAiTranslate200ResponseData } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "originalText": Hello, how are you today?,
+  "translatedText": 你好，你今天怎么样？,
+  "detectedLang": en,
+  "confidenceScore": 0.98,
+  "alternatives": ["你好，今天过得如何？"],
+  "explanation": null,
+} satisfies PostAiTranslate200ResponseData
+
+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 PostAiTranslate200ResponseData
+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/PostAiTranslate200ResponseDataExplanation.md

@@ -0,0 +1,38 @@
+
+# PostAiTranslate200ResponseDataExplanation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`keyPhrases` | Array<object>
+`culturalNotes` | Array<string>
+`grammarNotes` | Array<string>
+
+## Example
+
+```typescript
+import type { PostAiTranslate200ResponseDataExplanation } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "keyPhrases": null,
+  "culturalNotes": null,
+  "grammarNotes": null,
+} satisfies PostAiTranslate200ResponseDataExplanation
+
+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 PostAiTranslate200ResponseDataExplanation
+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/PostAiTranslate200ResponsePerformance.md

@@ -0,0 +1,36 @@
+
+# PostAiTranslate200ResponsePerformance
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`processingTimeMs` | number
+`cacheHit` | boolean
+
+## Example
+
+```typescript
+import type { PostAiTranslate200ResponsePerformance } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "processingTimeMs": 850,
+  "cacheHit": false,
+} satisfies PostAiTranslate200ResponsePerformance
+
+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 PostAiTranslate200ResponsePerformance
+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/PostAiTranslate200ResponseQualityMetrics.md

@@ -0,0 +1,41 @@
+
+# PostAiTranslate200ResponseQualityMetrics
+
+翻译质量指标，仅在单个翻译时返回。
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fluencyScore` | number
+`accuracyScore` | number
+`completenessScore` | number
+`totalScore` | number
+
+## Example
+
+```typescript
+import type { PostAiTranslate200ResponseQualityMetrics } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fluencyScore": 0.95,
+  "accuracyScore": 0.92,
+  "completenessScore": 0.98,
+  "totalScore": 0.95,
+} satisfies PostAiTranslate200ResponseQualityMetrics
+
+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 PostAiTranslate200ResponseQualityMetrics
+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/PostAiTranslate400Response.md

@@ -0,0 +1,38 @@
+
+# PostAiTranslate400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`message` | string
+`error` | string
+
+## Example
+
+```typescript
+import type { PostAiTranslate400Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 400,
+  "message": Invalid request parameters,
+  "error": either 'text' or 'texts' must be provided,
+} satisfies PostAiTranslate400Response
+
+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 PostAiTranslate400Response
+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/PostAiTranslate401Response.md

@@ -0,0 +1,38 @@
+
+# PostAiTranslate401Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`message` | string
+`error` | string
+
+## Example
+
+```typescript
+import type { PostAiTranslate401Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 401,
+  "message": Unauthorized,
+  "error": Invalid or missing API token,
+} satisfies PostAiTranslate401Response
+
+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 PostAiTranslate401Response
+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/PostAiTranslate429Response.md

@@ -0,0 +1,38 @@
+
+# PostAiTranslate429Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`message` | string
+`error` | string
+
+## Example
+
+```typescript
+import type { PostAiTranslate429Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 429,
+  "message": Rate limit exceeded,
+  "error": Too many requests, please try again later,
+} satisfies PostAiTranslate429Response
+
+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 PostAiTranslate429Response
+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/PostAiTranslate500Response.md

@@ -0,0 +1,40 @@
+
+# PostAiTranslate500Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`message` | string
+`error` | string
+`isBatch` | boolean
+
+## Example
+
+```typescript
+import type { PostAiTranslate500Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 500,
+  "message": Translation service error,
+  "error": Translation request failed,
+  "isBatch": false,
+} satisfies PostAiTranslate500Response
+
+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 PostAiTranslate500Response
+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/PostAiTranslateRequest.md

@@ -0,0 +1,48 @@
+
+# PostAiTranslateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`text` | string
+`texts` | Array<string>
+`sourceLang` | string
+`style` | string
+`context` | string
+`preserveFormat` | boolean
+`fastMode` | boolean
+`maxConcurrency` | number
+
+## Example
+
+```typescript
+import type { PostAiTranslateRequest } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "text": Hello, how are you today?,
+  "texts": null,
+  "sourceLang": en,
+  "style": professional,
+  "context": business,
+  "preserveFormat": true,
+  "fastMode": true,
+  "maxConcurrency": 3,
+} satisfies PostAiTranslateRequest
+
+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 PostAiTranslateRequest
+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/PostAnswerbookAsk200Response.md

@@ -0,0 +1,38 @@
+
+# PostAnswerbookAsk200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`question` | string
+`answer` | string
+
+## Example
+
+```typescript
+import type { PostAnswerbookAsk200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 200,
+  "question": 我应该接受这份工作吗？,
+  "answer": 专注当下,
+} satisfies PostAnswerbookAsk200Response
+
+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 PostAnswerbookAsk200Response
+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/PostAnswerbookAskRequest.md

@@ -0,0 +1,34 @@
+
+# PostAnswerbookAskRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`question` | string
+
+## Example
+
+```typescript
+import type { PostAnswerbookAskRequest } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "question": 我应该接受这份工作吗？,
+} satisfies PostAnswerbookAskRequest
+
+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 PostAnswerbookAskRequest
+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/PostClipzyStore200Response.md

@@ -0,0 +1,34 @@
+
+# PostClipzyStore200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+
+## Example
+
+```typescript
+import type { PostClipzyStore200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": PREF0Zv8Yj,
+} satisfies PostClipzyStore200Response
+
+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 PostClipzyStore200Response
+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)
+
+