uapi-browser-sdk 0.1.15 → 0.1.16

package/internal/docs/PostSearchAggregate200ResponseMetadata.md

@@ -0,0 +1,41 @@
+
+# PostSearchAggregate200ResponseMetadata
+
+本次请求的处理元数据
+
+## Properties
+
+Name | Type
+------------ | -------------
+`requestParams` | [PostSearchAggregate200ResponseMetadataRequestParams](PostSearchAggregate200ResponseMetadataRequestParams.md)
+`dedupeRemoved` | number
+`rerankApplied` | boolean
+`contentFetched` | number
+
+## Example
+
+```typescript
+import type { PostSearchAggregate200ResponseMetadata } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "requestParams": null,
+  "dedupeRemoved": 0,
+  "rerankApplied": true,
+  "contentFetched": 0,
+} satisfies PostSearchAggregate200ResponseMetadata
+
+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 PostSearchAggregate200ResponseMetadata
+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/PostSearchAggregate200ResponseMetadataRequestParams.md

@@ -0,0 +1,43 @@
+
+# PostSearchAggregate200ResponseMetadataRequestParams
+
+服务端实际生效的请求参数回显
+
+## Properties
+
+Name | Type
+------------ | -------------
+`query` | string
+`limit` | number
+`page` | number
+`timeoutMs` | number
+`sort` | string
+
+## Example
+
+```typescript
+import type { PostSearchAggregate200ResponseMetadataRequestParams } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "query": Go最新的版本是多少,
+  "limit": 10,
+  "page": 1,
+  "timeoutMs": 60000,
+  "sort": relevance,
+} satisfies PostSearchAggregate200ResponseMetadataRequestParams
+
+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 PostSearchAggregate200ResponseMetadataRequestParams
+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/PostSearchAggregate200ResponseResultsInner.md

@@ -14,7 +14,6 @@ Name | Type
 `position` | number
 `score` | number
 `publishTime` | Date
-`author` | string
 
 ## Example
 
@@ -23,15 +22,14 @@ import type { PostSearchAggregate200ResponseResultsInner } from 'uapi-browser-sd
 
 // TODO: Update the object below with actual values
 const example = {
-  "title": null,
-  "url": null,
-  "snippet": null,
-  "domain": null,
-  "source": null,
-  "position": null,
-  "score": null,
-  "publishTime": null,
-  "author": null,
+  "title": Go 1.26 正式发布,
+  "url": https://go.dev/blog/go1.26,
+  "snippet": 2026年2月10日，Go 团队正式发布了 Go 1.26 版本。,
+  "domain": go.dev,
+  "source": uapi-searchv1,
+  "position": 1,
+  "score": 0.93,
+  "publishTime": 2026-02-10T00:00Z,
 } satisfies PostSearchAggregate200ResponseResultsInner
 
 console.log(example)

package/internal/docs/PostSearchAggregate200ResponseSourcesInner.md

@@ -19,11 +19,11 @@ import type { PostSearchAggregate200ResponseSourcesInner } from 'uapi-browser-sd
 
 // TODO: Update the object below with actual values
 const example = {
-  "name": uapi-search,
+  "name": uapi-searchv1,
   "status": success,
-  "resultCount": 16,
-  "elapsedMs": 1256,
-  "firstResultHost": help.aliyun.com,
+  "resultCount": 15,
+  "elapsedMs": 3675,
+  "firstResultHost": go.dev,
 } satisfies PostSearchAggregate200ResponseSourcesInner
 
 console.log(example)

package/internal/docs/PostSearchAggregate400Response.md

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `code` | string
 `message` | string
-`timestamp` | Date
 
 ## Example
 
@@ -19,7 +18,6 @@ import type { PostSearchAggregate400Response } from 'uapi-browser-sdk-browser'
 const example = {
   "code": INVALID_REQUEST,
   "message": 请求参数格式错误,
-  "timestamp": 2024-01-15T10:30Z,
 } satisfies PostSearchAggregate400Response
 
 console.log(example)

package/internal/docs/PostSearchAggregate401Response.md

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `code` | string
 `message` | string
-`timestamp` | Date
 
 ## Example
 
@@ -19,7 +18,6 @@ import type { PostSearchAggregate401Response } from 'uapi-browser-sdk-browser'
 const example = {
   "code": UNAUTHORIZED,
   "message": 无效的访问令牌,
-  "timestamp": 2024-01-15T10:30Z,
 } satisfies PostSearchAggregate401Response
 
 console.log(example)

package/internal/docs/PostSearchAggregate429Response.md

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `code` | string
 `message` | string
-`timestamp` | Date
 
 ## Example
 
@@ -19,7 +18,6 @@ import type { PostSearchAggregate429Response } from 'uapi-browser-sdk-browser'
 const example = {
   "code": RATE_LIMIT_EXCEEDED,
   "message": 请求过于频繁，请稍后重试,
-  "timestamp": 2024-01-15T10:30Z,
 } satisfies PostSearchAggregate429Response
 
 console.log(example)

package/internal/docs/PostSearchAggregate500Response.md

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `code` | string
 `message` | string
-`timestamp` | Date
 
 ## Example
 
@@ -19,7 +18,6 @@ import type { PostSearchAggregate500Response } from 'uapi-browser-sdk-browser'
 const example = {
   "code": INTERNAL_ERROR,
   "message": 服务器内部错误,
-  "timestamp": 2024-01-15T10:30Z,
 } satisfies PostSearchAggregate500Response
 
 console.log(example)

package/internal/docs/PostSearchAggregateRequest.md

@@ -10,7 +10,6 @@ Name | Type
 `site` | string
 `filetype` | string
 `fetchFull` | boolean
-`timeoutMs` | number
 `sort` | string
 `timeRange` | string
 
@@ -25,7 +24,6 @@ const example = {
   "site": null,
   "filetype": null,
   "fetchFull": null,
-  "timeoutMs": null,
   "sort": null,
   "timeRange": null,
 } satisfies PostSearchAggregateRequest

package/internal/docs/PostTextMarkdownToHtml200Response.md

@@ -0,0 +1,34 @@
+
+# PostTextMarkdownToHtml200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [PostTextMarkdownToHtml200ResponseData](PostTextMarkdownToHtml200ResponseData.md)
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml200Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies PostTextMarkdownToHtml200Response
+
+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 PostTextMarkdownToHtml200Response
+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/PostTextMarkdownToHtml200ResponseData.md

@@ -0,0 +1,34 @@
+
+# PostTextMarkdownToHtml200ResponseData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`html` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml200ResponseData } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "html": <style>...</style><div class="uapi-markdown"><h1 id="coffee">咖啡</h1><p>...</p></div>,
+} satisfies PostTextMarkdownToHtml200ResponseData
+
+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 PostTextMarkdownToHtml200ResponseData
+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/PostTextMarkdownToHtml400Response.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToHtml400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml400Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INVALID_PARAMETER,
+  "message": format 只允许 json 或 html,
+} satisfies PostTextMarkdownToHtml400Response
+
+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 PostTextMarkdownToHtml400Response
+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/PostTextMarkdownToHtml400ResponseOneOf.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToHtml400ResponseOneOf
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml400ResponseOneOf } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INVALID_PARAMETER,
+  "message": 请求体格式不正确，请传标准 JSON,
+} satisfies PostTextMarkdownToHtml400ResponseOneOf
+
+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 PostTextMarkdownToHtml400ResponseOneOf
+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/PostTextMarkdownToHtml400ResponseOneOf1.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToHtml400ResponseOneOf1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml400ResponseOneOf1 } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INVALID_PARAMETER,
+  "message": format 只允许 json 或 html,
+} satisfies PostTextMarkdownToHtml400ResponseOneOf1
+
+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 PostTextMarkdownToHtml400ResponseOneOf1
+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/PostTextMarkdownToHtml413Response.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToHtml413Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml413Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": TEXT_TOO_LARGE,
+  "message": Markdown 内容不能超过 1MB,
+} satisfies PostTextMarkdownToHtml413Response
+
+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 PostTextMarkdownToHtml413Response
+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/PostTextMarkdownToHtml500Response.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToHtml500Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml500Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": REQUEST_FAILED,
+  "message": Markdown 转 HTML 失败，请稍后再试,
+} satisfies PostTextMarkdownToHtml500Response
+
+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 PostTextMarkdownToHtml500Response
+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/PostTextMarkdownToHtml503Response.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToHtml503Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtml503Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": SERVICE_TEMPORARILY_UNAVAILABLE,
+  "message": Markdown 转 HTML 服务暂时不可用，请稍后再试,
+} satisfies PostTextMarkdownToHtml503Response
+
+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 PostTextMarkdownToHtml503Response
+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/PostTextMarkdownToHtmlRequest.md

@@ -0,0 +1,81 @@
+
+# PostTextMarkdownToHtmlRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`text` | string
+`format` | string
+`sanitize` | boolean
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToHtmlRequest } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "text": # 咖啡
+
+**咖啡**（英语：*coffee*）是指将咖啡植物的种子（即[咖啡豆](https://baike.baidu.com/item/%E5%92%96%E5%95%A1%E8%B1%86/13579425)）经过烘焙磨粉后冲泡溶解制成的饮料，是世界上流行范围最为广泛的软性饮料之一。
+
+> 野生咖啡原产于非洲和亚洲的热带地区，现今，未经烘焙的生咖啡豆作为世界上最大的出口农产品，有超过70个国家种植咖啡树。
+
+![咖啡图片](https://images.unsplash.com/photo-1534234757579-8ad69d218ad4?q=80&w=1170&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D)
+
+## 营养价值 (每100克)
+
+| 营养成分 | 含量 | 每日参考摄入量 (DRI) |
+| :--- | :--- | :--- |
+| 热量 | 2 kJ (0.48 kcal) | - |
+| 咖啡因 | 40 mg | - |
+| 核黄素 (维生素B2) | 0.076 mg | 6% |
+| 镁 | 3 mg | 1% |
+| 钾 | 49 mg | 1% |
+
+## 咖啡制作工序
+
+咖啡从果实到杯中的饮品，需要经过严谨的步骤：
+
+- [x] **采收**：有机械采收和人工采收两种方式。
+- [x] **加工**：去除水果层，干燥到合适含水量（水洗法、日晒法、蜜处理等）。
+- [ ] **烘焙**：生豆水分释放、体积膨胀。分为浅焙、中焙、深焙。
+
+## 冲煮与萃取
+
+所有的咖啡都是由磨好的咖啡粉和热水制出的。常见的分类包括：
+
+1. **滴滤法**：如手冲咖啡。水与咖啡粉接触的机会只有一次。
+2. **压力法**：如意式浓缩咖啡（Espresso），以8～9个大气压的力道萃取。
+3. **浸泡法**：如冷泡咖啡，将研磨后的咖啡豆置于盛有冷水的玻璃瓶中静置。
+
+## 相关技术协议
+
+在计算机网络中，甚至有一个专门用于控制咖啡壶的协议（超文本咖啡壶控制协议，HTCPCP）：
+
+```http
+BREW /pot-1/coffee HTCPCP/1.0
+Host: coffee-pot.local
+Content-Type: message/coffeepot
+Accept-Additions: cream, whole-milk
+```,
+  "format": html,
+  "sanitize": true,
+} satisfies PostTextMarkdownToHtmlRequest
+
+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 PostTextMarkdownToHtmlRequest
+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/PostTextMarkdownToPdf400Response.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToPdf400Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToPdf400Response } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": UNSUPPORTED_MARKDOWN,
+  "message": 链接协议仅支持 http、https 或 mailto,
+} satisfies PostTextMarkdownToPdf400Response
+
+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 PostTextMarkdownToPdf400Response
+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/PostTextMarkdownToPdf400ResponseOneOf.md

@@ -0,0 +1,36 @@
+
+# PostTextMarkdownToPdf400ResponseOneOf
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostTextMarkdownToPdf400ResponseOneOf } from 'uapi-browser-sdk-browser'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": INVALID_PARAMETER,
+  "message": theme 只允许 light、dark、minimal、github,
+} satisfies PostTextMarkdownToPdf400ResponseOneOf
+
+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 PostTextMarkdownToPdf400ResponseOneOf
+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)
+
+