自定义接口模板

自定义接口模板 公开 已发布(自动)

zryan 更新于 2023-05-28 01:28 | 5 | 59
如何安装动作?
复制Ta的推荐码
最近忙碌,动作更新较慢,留言可能回复不及时

适用于
分类(旧)
翻译 示例

level1 AMOV 张立行 2016 抄书侠(GM) 5 人赞了这个动作

3 个动作单 收藏了此动作。

更多信息
分享时间 2023-05-07 16:54
最后更新 2023-05-28 01:28
修订版本 2
用户许可 -未设置-
Quicker版本 1.38.8
动作大小 2.1 KB

分享到

「Translator 配套动作」

简介

  前言:本动作为 Translator 的配套动作,不可单独使用。建议先了解 Translator 再看下述介绍。


   1 自定义接口动作库


  1. 360翻译接口(查句示例动作)
  2. 360词典接口(查词示例动作)
  3. 必应英义词典接口
  4. DeepL自定义接口(自填写APIKey)- by little_ant
  5. DeepLX - by 车站里的守望者
  6. Yandex翻译接口 - by vv12138
  7. 搜狗翻译接口 - by vv12138
  8. 自定义接口拼音 - by 南望山
  9. 必应翻译 - by vv12138
  10. 有道子曰翻译接口 - by zryan
  11. Quicker翻译接口 - by zryan
  12. ……

  感谢 vv12138little_ant 、车站里的守望者南望山 分享的接口,如果他们的接口有帮助到你,欢迎进入他们的主页使用他们的推荐码

(如果制作了相关接口动作并愿意分享的,可以在讨论区留言,将会添加到此列表中👏)




   2 自定义接口使用说明


1. 在 Translator 动作 右键的 设置 中添加自定义接口动作(开发自定义接口动作请参考下方第三部分的文档);



2. 将添加的项拖动到左侧“已选”框中。如果有需要,可以点击自定义“附加参数”“可见性表达式”

【附加参数】(选填)传入自定义接口动作的额外信息,一般无需填写。

【可见性表达式】(选填)填写一个Quicker表达式,要求返回布尔值,每次调用动作的时候会根据表达式的返回值判定此服务是否在翻译面板上显示。

返回为 true 则显示,false 则不显示,不填写则始终显示。


3. 正常使用(显示在面板上的名称图标都是在第 1 步中设定的)。





   3 自定义接口开发文档


以下内容基于本模板动作,请在此模板动作的基础上开发。(实际编写示例可以参考上述动作库中的动作)


  3.1 概述


自定义接口动作的执行流程为:

Translator调用动作+传入参数 → 自定义接口动作接收参数 → 通过自己编写的步骤获取翻译结果 → 回传结果 → Translator接收结果并显示

其中,本接口文档主要针对 “ 接收参数” 与 “ 回传结果” 两步中的数据规范。


  3.2 接收参数


通过 Translator_获取参数 模块获取 Translator 传来的相关参数。

【原文】Translator传来的需要翻译的原文内容;

【源语言】用户在翻译面板上选择的源语言(文末附),用 ISO 639-1 的语言代码 表示。

【检测语言】通过 Translator 动作内置的语言检测工具检测出的原文语言,可识别出 97 种语言(文末附),用   ISO 639-1 的语言代码 表示。

  • 对于长文本,识别准确率较高;
  • 对于短文本,识别准确率较低。

【目标语言】用户在翻译面板上选择的目标语言(与源语言列表相同),用  ISO 639-1 的语言代码 表示。

【附加参数】用户在 Translator右键 - 自定义接口的界面填写的附加参数,用于传入自定义的额外信息。


相关示例:

若原文检测到是中文,则源语言传入  zh,目标语言传入 en  .
若原文检测到不是中文,则源语言传入  auto,目标语言传入 zh .


  3.3 回传结果


通过 Translator_返回结果模块向 Translator 返回翻译的结果。


回传结果类型分为两种: 句子 单词 ,查词结果又根据填写结果的数据格式分为两种 对象格式 和 Json格式


  3.3.1 句子

在 Translator 上的显示效果




【译文】一段文本类型的翻译结果。


  3.3.2 单词(对象格式)

在 Translator 上的显示效果




【单词】(必填)

翻译结果上显示的单词,传入 文本类型数据

显示效果:


【发音】(必填)

单词的发音信息,传入一个 词典列表,即  List<Dictionary< string, string>>

每个Dictionary存储一行的发音信息,Dictionary中的键值类型如下:

值类型 值说明
type string 英音、美音等发音类型
value string 单词音标,传入时两侧不带 "["、"]" ,后面会自动添加
ttsBase64(可为空字符串) string 音频链接 Base64编码后结果,需要Qk的 播放声音 模块可直接播放的音频链接


显示效果:



【释义】(必填)

单词的释义信息,传入一个 词典列表,即  List<Dictionary< string, string>>

每个Dictionary存储一行的释义信息,Dictionary中的键值类型如下:

值类型 值说明
part string 本条释义的所属类型,如:名词释义- n. 动词释义- v.
mean string 释义内容


显示效果:



【其它形态】(选填)

单词的其它形态/变换形式,传入一个 词典列表,即  List<Dictionary< string, string>>

每个Dictionary存储一行的其它形态,Dictionary中的键值类型如下:

值类型 值说明
name string 其它形态的名称,如:复数、第三人称单数、过去式……
words string 其它形态的单词


显示效果:



【附加信息】(选填)

单词的其它附加信息,传入一个 词典列表,即  List<Dictionary< string, string>>

每个Dictionary存储一段附加信息(包括标题和内容),Dictionary中的键值类型如下:

值类型 值说明
name string 附加信息的标题,如:网络释义、词组短语、标签……
value string 附加信息的内容,可以有多行


显示效果:



【双语例句】(选填)

单词的双语例句,传入一个 词典列表,即  List<Dictionary< string, string>>

每个Dictionary存储一对双语例句和其发音信息,Dictionary中的键值类型如下:

值类型 值说明
index string 例句的序号或其它标识,注意类型为string
example string 双语例句,可多行,请自行分行放置例句
ttsBase64(可为空字符串) string 例句音频链接 Base64编码后结果,需要Qk的 播放声音 模块可直接播放的音频链接


显示效果:



  3.3.3 单词(Json格式)




Json格式从整体上来说和上面的对象格式是一一对应的,主要将 ListDictionary 换成了 Json 中的 []{},查看下述文档时可以和前文相互参照。


Json格式的示例如下:


{
  "isDict": true,                    // 必填,是否为词典结果,必须为true
  "transText": "",                   // 无需填写,在“查句”模式中才会用到
  "word": "text",                    // 必填,查询的单词
  "pronunciations": [                // 必填,发音信息数组
    {
      "type": "英",                  // 发音类型
      "value": "tekst",              // 音标(不含方括号)
      "ttsBase64": "..."             // 音频链接的Base64编码(可为空)
    },
    {
      "type": "美",
      "value": "tɛkst",
      "ttsBase64": "..."
    }
  ],
  "parts": [                         // 必填,词性释义数组
    {
      "part": "n.",                  // 词性
      "mean": "正文;文本;..."        // 释义内容
    }
  ],
  "exchanges": [                     // 选填,其它形态数组
    {
      "name": "复数",                // 形态名称
      "words": "texts"               // 形态内容
    }
  ],
  "additions": [                     // 选填,附加信息数组
    {
      "name": "标签",                // 附加信息标题
      "value": "TEM4, CET4"          // 附加信息内容
    }
  ],
  "examples": [                      // 选填,双语例句数组
    {
      "index": "1",                  // 例句序号
      "example": "I designed...",    // 例句内容(可多行)
      "ttsBase64": ""                // 例句音频链接的Base64编码(可为空)
    }
  ]
}


各字段的详细说明:


【isDict】 (必填)

布尔值,指示这是一个词典查询结果,必须为 true


【transText】 (无需填写)

字符串,无需填写,这是查句模式中的返回结果,在查词模式下不会用到。

相信你也发现了,实际上使用这里的 Json 格式同样也可以回传查句结果。只需要将上方的 isDict 字段改为 false,同时此处 transText 字段填写查句结果字符串。后续其余字段无需填写,直接回传,就相当于查句结果了。
【在此提及仅用作完备性展示,一般用户无需关注】


【word】 (必填)

字符串,词典结果上显示的单词。


【pronunciations】 (必填)

数组,包含单词的发音信息,每个元素是具有以下属性的对象:

  • type:字符串,发音类型,如"英"、"美"等
  • value:字符串,单词音标,传入时两侧不带"["、"]",后面会自动添加
  • ttsBase64:字符串,音频链接Base64编码后结果,可为空字符串


【parts】 (必填)

数组,包含单词的词性和释义,每个元素是具有以下属性的对象:

  • part:字符串,词性,如"n."、"v."等
  • mean:字符串,释义内容


【exchanges】(选填)

数组,包含单词的其它形态/变换形式,每个元素是具有以下属性的对象:

  • name:字符串,其它形态的名称,如"搭配词"、"复数"、"过去式"等
  • words:字符串,其它形态的单词或内容


【additions】(选填)

数组,包含单词的附加信息,每个元素是具有以下属性的对象:

  • name:字符串,附加信息的标题,如"标签"、"网络释义"等
  • value:字符串,附加信息的内容,可以有多行


【examples】(选填)

数组,包含单词的双语例句,每个元素是具有以下属性的对象:

  • index:字符串,例句的序号或其它标识
  • example:字符串,双语例句内容,可多行
  • ttsBase64:字符串,例句音频链接Base64编码后结果,可为空字符串




附录1:源和目标语言列表


语言(英) 语言(中) ISO 639-1 代码
AUTO 自动检测 auto
Cantonese 粤语 yue
Korean 韩语 ko
Thai 泰语 th
Portuguese 葡萄牙语 pt
Greek 希腊语 el
Bulgarian 保加利亚语 bg
Finnish 芬兰语 fi
Slovenian 斯洛文尼亚语 sl
Traditional-Chinese 繁体中文 zh-TW
Chinese 中文 zh
Classical-Chinese 文言文 wyw
French 法语 fr
Arabic 阿拉伯语 ar
German 德语 de
Dutch 荷兰语 nl
Estonian 爱沙尼亚语 et
Czech 捷克语 cs
Swedish 瑞典语 sv
Vietnamese 越南语 vi
English 英语 en
Japanese 日语 ja
Spanish 西班牙语 es
Russian 俄语 ru
Italian 意大利语 it
Polish 波兰语 pl
Danish 丹麦语 da
Romanian 罗马尼亚语 ro
Hungarian 匈牙利语 hu
Indonesian 印度尼西亚语 id
Malay 马来语 ms
Turkish 土耳其语 tr
Hindi 印地语 hi



附录2:可检测出的97种语言(ISO 693-1)

af, am, an, ar, as, az, be, bg, bn, br, bs, ca, cs, cy, da, de, dz, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, gu, he, hi, hr, ht, hu, hy, id, is, it, ja, jv, ka, kk, km, kn, ko, ku, ky, la, lb, lo, lt, lv, mg, mk, ml, mn, mr, ms, mt, nb, ne, nl, nn, no, oc, or, pa, pl, ps, pt, qu, ro, ru, rw, se, si, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, ug, uk, ur, vi, vo, wa, xh, zh, zu



作者所声明的动作特征:
  • 依赖其它动作

最近更新

修订版本 更新时间 更新说明
2 2023-05-28 01:28 添加 link 返回参数
1 2023-05-09 08:59 优化
0 2023-05-07 16:54

最近讨论