進行文字轉換

/convert

總結

此端點用於將文字做轉換。

備註

此頁面的內容未必會在新增移除轉換器或是模組時更新。 若要取得最新可用的轉換器與模組， 請參考 查看繁化姬設定 。

請求方法

  • GET, POST

請求參數

必填

屬性 說明 型別
text 將要被轉換的文字。 string
converter 所要使用的轉換器。有 Simplified （簡體化）、 Traditional （繁體化）、 China （中國化）、 Hongkong （香港化）、 Taiwan （台灣化）、 Pinyin （拼音化） Bopomofo （注音化）、 Mars （火星化）、 WikiSimplified （維基簡體化）、 WikiTraditional （維基繁體化）。 string

字幕樣式

屬性 說明 型別 預設值
ignoreTextStyles 由那些不希望被繁化姬處理的 "樣式" 以逗號分隔所組成的字串。通常用於保護特效字幕不被轉換，例如字幕組的特效字幕若是以 OPJP 與 OPCN 作為樣式名。可以設定 "OPJP,OPCN" 來作保護。 string ""
jpTextStyles 告訴繁化姬哪些樣式要當作日文處理（預設為伺服器端自動猜測）。若要自行設定，則必須另外再加入 *noAutoJpTextStyles 這個樣式。所有樣式以逗號分隔組成字串，例如： "OPJP,EDJP,*noAutoJpTextStyles" 表示不讓伺服器自動猜測，並指定 OPJP 與 EDJP 為日文樣式。 string ""

日文的處理策略

屬性 說明 型別 預設值
jpStyleConversionStrategy 對於日文樣式該如何處理。 "none" 表示 無（當成中文處理） 、 "protect" 表示 保護 、 "protectOnlySameOrigin" 表示 僅保護原文與日文相同的字 、 "fix" 表示 修正 。 string "protectOnlySameOrigin"
jpTextConversionStrategy 對於繁化姬自己發現的日文區域該如何處理。 "none" 表示 無（當成中文處理） 、 "protect" 表示 保護 、 "protectOnlySameOrigin" 表示 僅保護原文與日文相同的字 、 "fix" 表示 修正 。 string "protectOnlySameOrigin"

自訂取代

屬性 說明 型別 預設值
modules 強制設定模組啟用／停用 。 -1 / 0 / 1 分別表示 自動 / 停用 / 啟用 。字串使用 JSON 格式編碼。使用 * 可以先設定所有模組的狀態。例如：{"*":0,"Naruto":1,"Typo":1} 表示停用所有模組，但啟用 火影忍者 與 錯別字修正 模組。 JSON string "{}"
userPostReplace 轉換後再進行的額外取代。格式為 "搜尋1=取代1\n搜尋2=取代2\n..." 。 搜尋1 會在轉換後再被取代為 取代1 。 string ""
userPreReplace 轉換前先進行的額外取代。格式為 "搜尋1=取代1\n搜尋2=取代2\n..." 。 搜尋1 會在轉換前先被取代為 取代1 。 string ""
userProtectReplace 保護字詞不被繁化姬修改。格式為 "保護1\n保護2\n..." 。 保護1 、 保護2 等字詞將不會被繁化姬修改。 string ""

差異比較

屬性 說明 型別 預設值
diffCharLevel 是否使用字元級別的差異比較（否則為行級別），這將會使回應時間變長。 bool false
diffContextLines 所輸出的結果要包含多少行上下文。可以是 0~4 之間的整數。 int 1
diffEnable 是否要啟用差異比較。 bool false
diffIgnoreCase 是否要忽略英文大小寫的差異。 bool false
diffIgnoreWhiteSpaces 是否要忽略空格的差異。 bool false
diffTemplate 所要使用的輸出模板。可選的值有： Inline 、 SideBySide 、 Unified 、 Context 以及 Json 。 string "Inline"

文本整理

屬性 說明 型別 預設值
cleanUpText 根據所偵測到的文本格式做出對應的文本清理。例如 ASS 字幕 的編輯器訊息、空白的對話等等，將會被移除。 bool false
ensureNewlineAtEof 確保輸出的文本結尾處有一個且只有一個換行符。 bool false
translateTabsToSpaces 轉換每行開頭的 Tab 為數個空格。此值可以是 -1~8 之間的整數。 -1 表示不轉換； 0 表示移除開頭 Tab 。 1~8 表示轉換為數個空白。 int -1
trimTrailingWhiteSpaces 移除每行結尾的多餘空格。 bool false
unifyLeadingHyphen 將區分說話人用的連字號統一為半形減號。 bool false

回應參數

屬性 說明 型別
converter 此次轉換所使用的轉換器。 string
text 經過轉換後的文本。 string
diff 轉換前後的文本差異比較。若轉換時沒有啟用差異比較，則傳回 null 。 string | null
usedModules 此次轉換使用了哪些模組。 string[]
jpTextStyles 此次轉換將哪些樣式視為日文樣式。 string[]
textFormat 輸入的文本被繁化姬判定為何種格式。 string

回應範例

提示

對 内存不足！没法在视频聊天时播放视频。 做 台灣化 。 您可以點擊 此處 來查看真實的回傳結果。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
    // ...
    "data": {
        "converter": "Taiwan",
        "text": "記憶體不足！沒辦法在視訊聊天時播放影片。",
        "diff": null,
        "jpTextStyles": [],
        "usedModules": [
            "Unit",
            "Typo",
            "Smooth",
            "GanToZuo",
            "Repeat",
            "ProperNoun",
            "Punctuation"
        ],
        "textFormat": "PlainText"
    },
    // ...
}

留言板