请求与响应

这是一个自定义机器翻译配置部分的 自定义机器翻译。本节包含机器翻译请求的核心配置。

变量

• $ID

• $SOURCE_TEXT 或 $ORIGINAL_TEXT

• $TRANSLATED_TEXT

• $SOURCE_LANG

• $TARGET_LANG

可以在配置中使用模式变量，语法为 $SCHEMA_NAME.

例如：

{
    "schema": [
        { "type": "string", "name": "api_key", "title": "API Key", "default": "", "required": true, "message": "Required an API Key" },
    ],
    "request": {
        "method": "http_post",
        "url": "http://127.0.01/?key=$API_KEY"
        "options": {
            "headers": {
              "Authorization": "Bearer $API_KEY",
              "Content-Type": "application/json"
            }
        }        
    }
}

---

参数

方法: 字符串

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

初始网址: 字符串 （可选）

在发出实际请求之前要访问的初始 URL（用于网页抓取）。

url: 字符串

机器翻译服务的端点 URL。

encodeURI: 布尔值 （可选）

使用 UTF-8 代码单元转义字符，每个八位字节按格式进行编码为 %XX，如有必要左侧用 0 填充。UTF-16 中的孤立代理项不会编码任何有效的 Unicode 字符。 参考： encodeURI

encodeURIComponent: 布尔值 （可选）

使用与 相同的编码算法。 encodeURI。 转义除以下字符外的所有字符： A–Z a–z 0–9 - _ . ! ~ * ' ( ) 参考： encodeURIComponent

encodeURIExtra: 字符串 （可选）

用于通过正则表达式替换 URI 的附加函数。例如： ["%2F", "g", "\\%2F"]

userAgent: 字符串 （可选）

HTTP 请求的自定义 User-Agent 字符串。

querySelector: 字符串

返回 HTML 文档中与指定选择器或选择器组匹配的第一个元素。 参考： querySelector

querySelectorAll: 字符串 （可选）

返回一个静态 NodeList，表示与指定选择器组匹配的 HTML 元素列表。 参考： querySelectorAll

queryProperty: 字符串

指定要从选定的 HTML 元素中提取的属性：

• "value" - HTMLDataElement 的属性 [Reference]

• "innerText" - HTMLElement 的属性 [Reference]

• "textContent" - Node 的属性 [Reference]

• "innerHTML" - HTMLElement 的属性 [Reference]

body: 对象

用于 POST 请求的请求体。可以包含诸如 等变量，和 $SOURCE_TEXT, $SOURCE_LANG，以及 $TARGET_LANG.

options: 对象 （可选）

附加请求选项。

• headers - 设置自定义请求头：

  • X-Custom-Header: 字符串

  • Authorization: 字符串

  • Content-Type: 字符串

responseType: 字符串

• "string" - 将响应类型设置为字符串

• "json" - 将响应类型设置为 json

responseQuery: 字符串

---

从 HTTP 请求解析 JSON 响应

可以使用 responseQuery 参数解析 JSON 响应。

该 responseQuery 该参数仅用于 http_get 和 http_post 方法，当响应类型设置为 json.

要遍历嵌套的 JSON 对象，请使用点表示法（.）来分隔字段名。数组元素可以使用带索引的括号表示法访问（例如， [0]).

示例 JSON 响应：

{
  "text": "Hello 1",
  "words": [
    { "text": "Hello 2" },
    { "text": "Hello 3" }
  ]
  "lines": {
    "text": "Hello 4",
    "sub": {
      "text": "Hello 5"
    }        
  }
}

responseQuery	结果
text	Hello 1
words[0].text	Hello 2
lines.sub.text	Hello 5

---

---

示例

1. 网页抓取方法

必需参数

• 方法: 字符串 ("web_scraping")

• 网址: 字符串

• querySelector: 字符串

• queryProperty: 字符串

{
    "request": {
        "method": "web_scraping",
        "encodeURI": false,
        "encodeURIComponent": true, 
        "initialUrl": "https://localhost:8080",
        "url": "https://localhost:8080/?sl=$SOURCE_LANG&tl=$TARGET_LANG&text=$SOURCE_TEXT",    
        "querySelector": "span[lang=$TARGET_LANG]",
        "queryProperty": "innerText"
    }
}

---

2. HTTP GET 方法

必需参数

• 方法: 字符串 ("http_get")

• 网址: 字符串

• responseType: 字符串

• responseQuery: 字符串

{
    "request": {
        "method": "http_get",
        "encodeURI": false,
        "encodeURIComponent": false, 
        "url": "https://localhost:8080/translate?sl=$SOURCE_LANG&tl=$TARGET_LANG&text=$SOURCE_TEXT",
        "options": {},
        "responseType": "json",
        "responseQuery": "translate.result"
    }
}

---

3. HTTP POST 方法

必需参数

• 方法: 字符串 ("http_post")

• 网址: 字符串

• 正文: 对象

• 选项: 对象

  • headers: 对象

    • X-Custom-Header: string

    • Authorization: string

    • Content-Type: string

• responseType: 字符串

• responseQuery: 字符串

{
    "request": {
        "method": "http_post",
        "encodeURI": false,
        "encodeURIComponent": false, 
        "url": "https://localhost:8080/translate",
        "body": {
            "text": "$SOURCE_TEXT",
            "source_lang": "$SOURCE_LANG",
            "target_lang": "$TARGET_LANG"
        }
        "options": {
            "headers": {
                "Authorization": "Bearer $API_KEY",
                "Content-Type": "application/json"
            }
        },
        "responseType": "json",
        "responseQuery": "translate.result"
    }
}