uapi-browser-sdk 0.1.4 → 0.1.11

package/internal/docs/ImageApi.md

@@ -5,13 +5,14 @@ All URIs are relative to *https://uapis.cn/api/v1*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**getAvatarGravatar**](ImageApi.md#getavatargravatar) | **GET** /avatar/gravatar | 获取Gravatar头像 |
-| [**getImageBingDaily**](ImageApi.md#getimagebingdaily) | **GET** /image/bing-daily | 获取必应每日壁纸 |
-| [**getImageMotou**](ImageApi.md#getimagemotou) | **GET** /image/motou | 生成摸摸头GIF (QQ号方式) |
-| [**getImageQrcode**](ImageApi.md#getimageqrcode) | **GET** /image/qrcode | 动态生成二维码 |
-| [**getImageTobase64**](ImageApi.md#getimagetobase64) | **GET** /image/tobase64 | 将在线图片转换为Base64 |
+| [**getImageBingDaily**](ImageApi.md#getimagebingdaily) | **GET** /image/bing-daily | 必应壁纸 |
+| [**getImageMotou**](ImageApi.md#getimagemotou) | **GET** /image/motou | 生成摸摸头GIF (QQ号) |
+| [**getImageQrcode**](ImageApi.md#getimageqrcode) | **GET** /image/qrcode | 生成二维码 |
+| [**getImageTobase64**](ImageApi.md#getimagetobase64) | **GET** /image/tobase64 | 图片转 Base64 |
 | [**postImageCompress**](ImageApi.md#postimagecompress) | **POST** /image/compress | 无损压缩图片 |
 | [**postImageFrombase64**](ImageApi.md#postimagefrombase64operation) | **POST** /image/frombase64 | 通过Base64编码上传图片 |
-| [**postImageMotou**](ImageApi.md#postimagemotou) | **POST** /image/motou | 生成摸摸头GIF (图片上传或URL方式) |
+| [**postImageMotou**](ImageApi.md#postimagemotou) | **POST** /image/motou | 生成摸摸头GIF |
+| [**postImageNsfw**](ImageApi.md#postimagensfw) | **POST** /image/nsfw | 图片敏感检测 |
 | [**postImageSpeechless**](ImageApi.md#postimagespeechlessoperation) | **POST** /image/speechless | 生成你们怎么不说话了表情包 |
 | [**postImageSvg**](ImageApi.md#postimagesvg) | **POST** /image/svg | SVG转图片 |
 
@@ -102,7 +103,7 @@ No authorization required
 
 > Blob getImageBingDaily()
 
-获取必应每日壁纸
+必应壁纸
 
 每天都想换张新壁纸？让必应的美图点亮你的一天吧！  ## 功能概述 这个接口会获取 Bing 搜索引擎当天全球同步的每日壁纸，并直接以图片形式返回。你可以用它来做应用的启动页、网站背景，或者任何需要每日更新精美图片的地方。  ## 使用须知  > [!NOTE] > **响应格式是图片** > 请注意，此接口成功时直接返回图片二进制数据（通常为 `image/jpeg`），而非 JSON 格式。请确保客户端能够正确处理。  我们内置了备用方案：如果从必应官方获取图片失败，系统会尝试返回一张预存的高质量风景图，以保证服务的稳定性。
 
@@ -162,7 +163,7 @@ No authorization required
 
 > Blob getImageMotou(qq, bgColor)
 
-生成摸摸头GIF (QQ号方式)
+生成摸摸头GIF (QQ号)
 
 想在线rua一下好友的头像吗？这个趣味接口可以满足你。  ## 功能概述 此接口通过GET方法，专门用于通过QQ号生成摸摸头GIF。你只需要提供一个QQ号码，我们就会自动获取其公开头像，并制作成一个可爱的动图。  ## 使用须知 - **响应格式**：接口成功时直接返回 `image/gif` 格式的二进制数据。 - **背景颜色**：你可以通过 `bg_color` 参数来控制GIF的背景。使用 `transparent` 选项可以让它更好地融入各种聊天背景中。
 
@@ -232,11 +233,11 @@ No authorization required
 
 ## getImageQrcode
 
-> Blob getImageQrcode(text, size, format)
+> Blob getImageQrcode(text, size, format, transparent, fgcolor, bgcolor)
 
-动态生成二维码
+生成二维码
 
-无论是网址、文本还是联系方式，通通可以变成一个二维码！这是一个非常灵活的二维码生成工具。  ## 功能概述 你提供一段文本内容，我们为你生成对应的二维码图片。你可以自定义尺寸，并选择不同的返回格式以适应不同场景。  ## 使用须知  > [!IMPORTANT] > **关键参数 `format`** > 此参数决定了成功响应的内容类型和结构，请务必根据你的需求选择并正确处理响应： > - **`image`** (默认): 直接返回 `image/png` 格式的图片二进制数据，适合在 `<img>` 标签中直接使用。 > - **`json`**: 返回一个包含 Base64 Data URI 的 JSON 对象，适合需要在前端直接嵌入CSS或HTML的场景。 > - **`json_url`**: 返回一个包含图片临时URL的JSON对象，适合需要图片链接的场景。
+无论是网址、文本还是联系方式，通通可以变成一个二维码！这是一个非常灵活的二维码生成工具。  ## 功能概述 你提供一段文本内容，我们为你生成对应的二维码图片。你可以自定义尺寸、前景色、背景色，还支持透明背景，并选择不同的返回格式以适应不同场景。  ## 使用须知  > [!IMPORTANT] > **关键参数 `format`** > 此参数决定了成功响应的内容类型和结构，请务必根据你的需求选择并正确处理响应： > - **`image`** (默认): 直接返回 `image/png` 格式的图片二进制数据，适合在 `<img>` 标签中直接使用。 > - **`json`**: 返回一个包含 Base64 Data URI 的 JSON 对象，适合需要在前端直接嵌入CSS或HTML的场景。 > - **`json_url`**: 返回一个包含图片临时URL的JSON对象，适合需要图片链接的场景。  > [!TIP] > **颜色参数说明** > - 颜色参数使用十六进制格式（如 `#FF0000`） > - URL 中需要对 `#` 进行编码，即 `%23`（例如：`fgcolor=%23FF0000`） > - 当 `transparent=true` 时，`bgcolor` 参数会被忽略
 
 ### Example
 
@@ -254,10 +255,16 @@ async function example() {
   const body = {
     // string | 你希望编码到二维码中的任何文本内容，比如一个URL、一段话或者一个JSON字符串。
     text: https://www.bilibili.com/video/BV1uT4y1P7CX/,
-    // number | 二维码图片的边长（正方形），单位是像素。有效范围是 256 到 1024 之间。 (optional)
+    // number | 二维码图片的边长（正方形），单位是像素。有效范围是 256 到 2048 之间。 (optional)
     size: 512,
     // 'image' | 'json' | 'json_url' | 指定响应内容的格式。可选值为 `image`, `json`, `json_url`。 (optional)
     format: image,
+    // boolean | 是否使用透明背景。启用后生成的 PNG 图片将具有 alpha 通道，背景透明。 (optional)
+    transparent: true,
+    // string | 二维码前景色（即二维码本身的颜色），使用十六进制格式。URL 中需要将 `#` 编码为 `%23`。 (optional)
+    fgcolor: fgcolor_example,
+    // string | 二维码背景色，使用十六进制格式。当 `transparent=true` 时此参数会被忽略。URL 中需要将 `#` 编码为 `%23`。 (optional)
+    bgcolor: bgcolor_example,
   } satisfies GetImageQrcodeRequest;
 
   try {
@@ -278,8 +285,11 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **text** | `string` | 你希望编码到二维码中的任何文本内容，比如一个URL、一段话或者一个JSON字符串。 | [Defaults to `undefined`] |
-| **size** | `number` | 二维码图片的边长（正方形），单位是像素。有效范围是 256 到 1024 之间。 | [Optional] [Defaults to `256`] |
+| **size** | `number` | 二维码图片的边长（正方形），单位是像素。有效范围是 256 到 2048 之间。 | [Optional] [Defaults to `256`] |
 | **format** | `image`, `json`, `json_url` | 指定响应内容的格式。可选值为 `image`, `json`, `json_url`。 | [Optional] [Defaults to `'image'`] [Enum: image, json, json_url] |
+| **transparent** | `boolean` | 是否使用透明背景。启用后生成的 PNG 图片将具有 alpha 通道，背景透明。 | [Optional] [Defaults to `false`] |
+| **fgcolor** | `string` | 二维码前景色（即二维码本身的颜色），使用十六进制格式。URL 中需要将 `#` 编码为 `%23`。 | [Optional] [Defaults to `'#000000'`] |
+| **bgcolor** | `string` | 二维码背景色，使用十六进制格式。当 `transparent=true` 时此参数会被忽略。URL 中需要将 `#` 编码为 `%23`。 | [Optional] [Defaults to `'#FFFFFF'`] |
 
 ### Return type
 
@@ -309,7 +319,7 @@ No authorization required
 
 > GetImageTobase64200Response getImageTobase64(url)
 
-将在线图片转换为Base64
+图片转 Base64
 
 看到一张网上的图片，想把它转换成 Base64 编码以便嵌入到你的 HTML 或 CSS 中？用这个接口就对了。  ## 功能概述 你提供一个公开可访问的图片 URL，我们帮你把它下载下来，并转换成包含 MIME 类型的 Base64 Data URI 字符串返回给你。
 
@@ -380,7 +390,7 @@ No authorization required
 
 无损压缩图片
 
-还在为图片体积和加载速度发愁吗？体验一下我们强大的**无损压缩服务**，它能在几乎不牺牲任何肉眼可感知的画质的前提下，将图片体积压缩到极致。  ## 功能概述 你只需要上传一张常见的图片（如 PNG, JPG），选择一个压缩等级，就能获得一个体积小到惊人的压缩文件。这对于需要大量展示高清图片的网站、App 或小程序来说，是优化用户体验、节省带宽和存储成本的利器。  ## 使用须知 > [!TIP] > 为了给您最好的压缩效果，我们的算法需要进行复杂计算，处理时间可能会稍长一些，请耐心等待。  > [!WARNING] > **服务排队提醒** > 这是一个计算密集型服务。在高并发时，您的请求可能会被排队等待处理。如果您需要将其集成到对延迟敏感的生产服务中，请注意这一点。  ### 请求与响应格式 - 请求必须使用 `multipart/form-data` 格式上传文件。 - 成功响应将直接返回压缩后的文件二进制流 (`application/octet-stream`)，并附带 `Content-Disposition` 头，建议客户端根据此头信息保存文件。  ## 参数详解 ### `level` (压缩等级) 这是一个从 `1` 到 `5` 的整数，它决定了压缩的强度和策略，数字越小，压缩率越高。所有等级都经过精心调校，以在最大化压缩率的同时保证出色的视觉质量。 - `1`: **极限压缩** (推荐，体积最小，画质优异) - `2`: **高效压缩** - `3`: **智能均衡** (默认选项) - `4`: **画质优先** - `5`: **专业保真** (压缩率稍低，保留最多图像信息)  ## 错误处理指南 - **400 Bad Request**: 通常因为没有上传文件，或者 `level` 参数不在 1-5 的范围内。 - **500 Internal Server Error**: 如果在压缩过程中服务器发生内部错误，会返回此状态码。
+还在为图片体积和加载速度发愁吗？体验一下我们强大的**无损压缩服务**，它能在几乎不牺牲任何肉眼可感知的画质的前提下，将图片体积压缩到极致。  ## 功能概述 你只需要上传一张常见的图片（如 PNG, JPG），选择一个压缩等级，就能获得一个体积小到惊人的压缩文件。这对于需要大量展示高清图片的网站、App 或小程序来说，是优化用户体验、节省带宽和存储成本的利器。  ## 使用须知 > [!TIP] > 为了给您最好的压缩效果，我们的算法需要进行复杂计算，处理时间可能会稍长一些，请耐心等待。  > [!WARNING] > **服务排队提醒** > 这是一个计算密集型服务。在高并发时，您的请求可能会被排队等待处理。如果您需要将其集成到对延迟敏感的生产服务中，请注意这一点。  ### 请求与响应格式 - 请求必须使用 `multipart/form-data` 格式上传文件。 - 成功响应将直接返回压缩后的文件二进制流 (`image/_*`)，并附带 `Content-Disposition` 头，建议客户端根据此头信息保存文件。  ## 参数详解 ### `level` (压缩等级) 这是一个从 `1` 到 `5` 的整数，它决定了压缩的强度和策略，数字越小，压缩率越高。所有等级都经过精心调校，以在最大化压缩率的同时保证出色的视觉质量。 - `1`: **极限压缩** (推荐，体积最小，画质优异) - `2`: **高效压缩** - `3`: **智能均衡** (默认选项) - `4`: **画质优先** - `5`: **专业保真** (压缩率稍低，保留最多图像信息)  ## 错误处理指南 - **400 Bad Request**: 通常因为没有上传文件，或者 `level` 参数不在 1-5 的范围内。 - **500 Internal Server Error**: 如果在压缩过程中服务器发生内部错误，会返回此状态码。
 
 ### Example
 
@@ -442,7 +452,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | ѹ���ɹ�����Ӧ����ѹ������ͼƬ���������ݡ�Content-Type ��������ѡ��Ŀ��ʽ����Ĭ��Ϊ image/png�� |  * Content-Disposition - ����ͻ��˽��ļ�����Ϊѹ�������ļ������Ƽ�ʹ��׺����������ʽ�� <br>  |
+| **200** | 压缩成功响应。响应是压缩后的图片二进制数据。&#x60;Content-Type&#x60; 依据选择的目标格式，默认为 image/png。 |  * Content-Disposition - 提示客户端文件下载为压缩后的文件。建议扩展名与输出格式一致。 <br>  |
 | **400** | 请求无效。可能是未上传文件、文件格式不受支持或参数错误。 |  -  |
 | **500** | 服务器内部错误。压缩过程中发生错误。 |  -  |
 
@@ -522,7 +532,7 @@ No authorization required
 
 > Blob postImageMotou(imageUrl, file, bgColor)
 
-生成摸摸头GIF (图片上传或URL方式)
+生成摸摸头GIF
 
 除了使用QQ头像，你还可以通过上传自己的图片或提供图片URL来制作独一无二的摸摸头GIF。  ## 功能概述 此接口通过POST方法，支持两种方式生成GIF： 1.  **图片URL**：在表单中提供 &#x60;image_url&#x60; 字段。 2.  **上传图片**：在表单中上传 &#x60;file&#x60; 文件。  ## 使用须知 - **响应格式**：接口成功时直接返回 &#x60;image/gif&#x60; 格式的二进制数据。 - **参数优先级**：如果同时提供了 &#x60;image_url&#x60; 和上传的 &#x60;file&#x60; 文件，系统将 **优先使用 &#x60;image_url&#x60;**。 - **背景颜色**：同样支持 &#x60;bg_color&#x60; 表单字段来控制GIF背景。
 
@@ -593,13 +603,86 @@ 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)
 
 
+## postImageNsfw
+
+> PostImageNsfw200Response postImageNsfw(file, url)
+
+图片敏感检测
+
+这是一个图片内容审核接口，自动识别图片中的违规内容并返回处理建议。  &gt; [!VIP] &gt; 此接口限时免费开放，无需企业认证即可使用。  ## 功能概述 上传图片文件或提供图片URL，接口会自动分析图片内容，返回是否违规、风险等级和处理建议。适合对接到用户上传流程中，实现自动化内容审核。  ## 返回字段说明 - **is_nsfw**: 是否判定为违规内容，&#x60;true&#x60; 表示违规，&#x60;false&#x60; 表示正常 - **nsfw_score**: 违规内容置信度，0-1 之间，越高表示越可能违规 - **normal_score**: 正常内容置信度，0-1 之间，与 nsfw_score 互补 - **suggestion**: 处理建议   - &#x60;pass&#x60;: 内容正常，可以直接放行   - &#x60;review&#x60;: 存在风险，建议转人工复核   - &#x60;block&#x60;: 高风险内容，建议直接拦截 - **risk_level**: 风险等级   - &#x60;low&#x60;: 低风险   - &#x60;medium&#x60;: 中风险   - &#x60;high&#x60;: 高风险 - **label**: 内容标签，&#x60;nsfw&#x60; 或 &#x60;normal&#x60; - **confidence**: 模型对当前判断的整体置信度 - **inference_time_ms**: 模型推理耗时，单位毫秒
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImageApi,
+} from 'uapi-browser-sdk-browser';
+import type { PostImageNsfwRequest } from 'uapi-browser-sdk-browser';
+
+async function example() {
+  console.log("🚀 Testing uapi-browser-sdk-browser SDK...");
+  const api = new ImageApi();
+
+  const body = {
+    // Blob | 要检测的图片文件。支持 JPG、JPEG、PNG、GIF、WebP 格式，最大 20MB。 (optional)
+    file: BINARY_DATA_HERE,
+    // string | 图片的 URL 地址。如果同时提供 file 和 url，将优先使用 file。 (optional)
+    url: url_example,
+  } satisfies PostImageNsfwRequest;
+
+  try {
+    const data = await api.postImageNsfw(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **file** | `Blob` | 要检测的图片文件。支持 JPG、JPEG、PNG、GIF、WebP 格式，最大 20MB。 | [Optional] [Defaults to `undefined`] |
+| **url** | `string` | 图片的 URL 地址。如果同时提供 file 和 url，将优先使用 file。 | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PostImageNsfw200Response**](PostImageNsfw200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 检测成功！返回图片的 NSFW 分析结果。 |  -  |
+| **400** | 请求参数错误。可能是未提供图片、文件格式不支持或文件过大。 |  -  |
+| **413** | 文件过大。上传的图片超过了 20MB 的限制。 |  -  |
+| **500** | 服务器内部错误。在处理图片或进行 NSFW 检测时发生错误。 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postImageSpeechless
 
 > Blob postImageSpeechless(postImageSpeechlessRequest)
 
 生成你们怎么不说话了表情包
 
-你们怎么不说话了？是不是都在偷偷玩Uapi，求求你们不要玩Uapi了  ## 效果展示 ![示例](https://uapis.cn/static/uploads/33580466897f1e5815296f235b582815.png)  ## 使用须知 - **响应格式**：接口成功时直接返回 &#x60;image/jpeg&#x60; 格式的二进制数据。 - **文字内容**：至少需要提供 &#x60;top_text&#x60;（上方文字）或 &#x60;bottom_text&#x60;（下方文字）之一。 - **梗图逻辑**：上方描述某个行为，下方通常以「们」开头表示劝阻，形成戏谑的对比效果。
+你们怎么不说话了？是不是都在偷偷玩Uapi，求求你们不要玩Uapi了  ## 使用须知 - **响应格式**：接口成功时直接返回 &#x60;image/png&#x60; 格式的二进制数据。 - **文字内容**：至少需要提供 &#x60;top_text&#x60;（上方文字）或 &#x60;bottom_text&#x60;（下方文字）之一。 - **梗图逻辑**：上方描述某个行为，下方通常以「们」开头表示劝阻，形成戏谑的对比效果。
 
 ### Example
 
@@ -655,7 +738,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | ���ɳɹ�����Ӧ����PNG��ʽ�ı����ͼƬ���������ݡ� |  -  |
+| **200** | 生成成功！响应体是PNG格式的表情包图片二进制数据。 |  -  |
 | **400** | 请求参数错误。必须提供 \&#39;top_text\&#39; 或 \&#39;bottom_text\&#39; 至少其中之一。 |  -  |
 | **500** | 服务器内部错误。在生成表情包图片过程中发生错误。 |  -  |