リクエストとレスポンス

これは次の設定セクションです カスタム MT。このセクションには機械翻訳リクエストのコア設定が含まれます。

変数

• $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"
            }
        }        
    }
}

---

パラメータ

method: string

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

initialUrl: string （オプション）

実際のリクエストを行う前に訪問する初期URL（ウェブスクレイピング用）。

url: string

機械翻訳サービスのエンドポイントURL。

encodeURI: boolean （オプション）

UTF-8コード単位を使って文字をエスケープし、各オクテットを次の形式でエンコードします %XX、必要に応じて0で左パディングします。UTF-16の孤立サロゲートは有効なUnicode文字をエンコードしません。 参照： encodeURI

encodeURIComponent: boolean （オプション）

と同じエンコーディングアルゴリズムを使用します encodeURI。 次の文字を除くすべての文字をエスケープします： A–Z a–z 0–9 - _ . ! ~ * ' ( ) 参照： encodeURIComponent

encodeURIExtra: string （オプション）

正規表現を使用してURIを置換する追加関数。例えば： ["%2F", "g", "\\%2F"]

userAgent: string （オプション）

HTTPリクエストのカスタムUser-Agent文字列。

querySelector: string

指定したセレクタまたはセレクタ群に一致する、HTMLドキュメント内の最初の要素を返します。 参照： querySelector

querySelectorAll: string （オプション）

指定したセレクタ群に一致するHTML要素のリストを表す静的なNodeListを返します。 参照： querySelectorAll

queryProperty: string

選択されたHTML要素から抽出するプロパティを指定します：

• "value" - HTMLDataElementのプロパティ [Reference]

• "innerText" - HTMLElementのプロパティ [Reference]

• "textContent" - Nodeのプロパティ [Reference]

• "innerHTML" - HTMLElementのプロパティ [Reference]

body: object

POSTリクエストのリクエストボディ。などの変数を含めることができます $SOURCE_TEXT, $SOURCE_LANG、および $TARGET_LANG.

options: object （オプション）

追加のリクエストオプション。

• headers - カスタムリクエストヘッダーを設定：

  • X-Custom-Header: string

  • Authorization: string

  • Content-Type: string

responseType: string

• "string" - レスポンスタイプを文字列に設定

• "json" - レスポンスタイプをJSONに設定

responseQuery: string

---

HTTPリクエストからのJSONレスポンスの解析

JSONレスポンスは次を使用して解析できます responseQuery パラメータ。

この 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. ウェブスクレイピング方法

必須パラメータ

• method: string （"web_scraping"）

• url: string

• querySelector: string

• queryProperty: string

{
    "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方法

必須パラメータ

• method: string （"http_get"）

• url: string

• responseType: string

• responseQuery: string

{
    "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方法

必須パラメータ

• method: string （"http_post"）

• url: string

• body: object

• options: object

  • headers: object

    • X-Custom-Header: string

    • Authorization: string

    • Content-Type: string

• responseType: string

• responseQuery: string

{
    "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"
    }
}