Запрос и ответ

Это раздел конфигурации Пользовательский 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, при необходимости дополненный слева нулём. Одинокие суррогаты в UTF-16 не кодируют никаких допустимых символов Unicode. Справка: encodeURI

encodeURIComponent: boolean (необязательно)

Использует тот же алгоритм кодирования, что и encodeURI. Экранирует все символы, кроме: A–Z a–z 0–9 - _ . ! ~ * ' ( ) Справка: encodeURIComponent

encodeURIExtra: string (необязательно)

Дополнительная функция для замены частей URI с использованием регулярного выражения. Например: ["%2F", "g", "\\%2F"]

userAgent: string (необязательно)

Пользовательская строка User-Agent для HTTP-запроса.

querySelector: string

Возвращает первый элемент внутри HTML-документа, который соответствует указанному селектору или группе селекторов. Справка: querySelector

querySelectorAll: string (необязательно)

Возвращает статический NodeList, представляющий список HTML-элементов, соответствующих указанной группе селекторов. Справка: 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" - установить тип ответа как string

• "json" - установить тип ответа как json

responseQuery: string

---

Разбор JSON-ответов из HTTP-запросов

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