Настройка узла через узел Параметры

Данная операция позволяет пользователям устанавливать настройки узла по умолчанию через настройки узла Параметры.

URL

/parameters/configure

Метод

POST

Диапазон

project_edit

Тип ответа

async

Параметры запроса

Имя Тип Обязательный Описание

prjUUID

строка

да

ID проекта.

obj

число

да

ID узла Параметры.

prjUUID должен быть действительным ID проекта.

Тело запроса (application/json)

{
  "type": "TmlLinkTerms/",
  "settings": {
    "Expression": "Test"
  },
  "declareUnsync": true,
  "hardUpdate": false,
  "strategies": [
    8,
    9,
    11
  ]
}

где

Имя Тип Обязательный Описание

type

строка

да

В запросе указывается тип узла, а не его название (см. таблицу ниже).

Тип узла, для которого необходимо задать параметры по умолчанию.

settings

JSON-объект

да

Параметры узла по умолчанию.

declareUnsync

булевый

нет

Определяет, следует ли сбросить статус узла Параметры и обновить настройки дочерних узлов.

Если значение равно false, статус узла Параметры не будет сброшен.

hardUpdate

булевый

нет

Определяет, следует ли запускать волну выполнения для отправки параметров дочерним узлам.

Если значение false, статус узлов будет сброшен.

strategies

массив

нет

Стратегии, которые могут быть применены к узлу, т.е. дополнительные параметры настроек узла.

Чтобы узнать, какие параметры и стратегии используются для того или иного узла, см. соответствующий запрос.

Только ID узла Параметры может быть указан в поле obj.

В таблице представлено соответствие названий узлов поддерживаемым типам (для значения type):

Название узла Тип узла

Экспорт в файл

CSV Exporter/

Файлы CSV

DataSource/CSV

Microsoft Excel

DataSource/EXCEL

Файлы

DataSource/FILES

Интернет

DataSource/INET

ODBC

DataSource/ODBC

RSS

DataSource/RSS

XML

DataSource/XML

Смещенная выборка

Dataset/Biased

Извлечение терминов

Dataset/ExtractTerms

Python

Dataset/Python

R

Dataset/R

Замена терминов

Dataset/ReplaceTerms

Экспорт в ODBC

ODBC Exporter/

Таксономия

PA6TaxonomyResult/TaxonomyResult

Фильтрация строк

SRLRuleSet/Filter Rows

Производные колонки

SRLRuleSet/SRL Rule

Извлечение фактов

TmlEntityExtractor/FEX

Извлечение сущностей

TmlEntityExtractor/XEE

Анализ тональности

TmlEntityExtractor/XSA

Связь терминов

TmlLinkTerms/

Вы можете просмотреть полный список типов узлов, отправив следующий запрос (GET):

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/parameters/nodes

без каких-либо параметров или тела запроса.

Таким образом, вы получите список узлов, указанных в узле Параметры, а также их название, тип и список параметров. Более подробная информация по запросу приведена здесь.

Типы узлов, возвращаемых из запроса, немного отличаются от приведенных в таблице выше: каждый тип указывается с обратной косой чертой \, например, ODBC Exporter\/, а не ODBC Exporter/. Вы можете использовать любой вариант.

Пример URL-запроса

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/parameters/configure?prjUUID=cf284754-841c-4c8a-a26c-e14303428dd4&obj=176

Таким образом, зная наименование узлов и их список параметров, вы можете задать настройки этих узлов через запрос /parameters/configure. В качестве примера рассмотрим конфигурацию настроек узла Ручной ввод.

{
  "type": "DataSource/MANUALINPUT",
  "declareUnsync": true,
  "hardUpdate": false,
  "settings": {
    "Data source": "{\"First column\": \"First row value\", \"Second column\": \"First row value\"}",
    "Columns order": "[\"First column\", \"Second column\"]"
  }
}

В примере выше мы передали настройки узла Ручной ввод через узел Параметры. Обратите внимание, что поля внутри объекта settings должны иметь строка тип и их значения должны быть переданы в кавычках. В поле Data source задается имя и значение новой колонки по схеме "ключ-значение".

Обратите внимание на необходимость экранирования кавычек в значениях полей Data source и Columns order.

Чтобы добавить более одной строки, передайте колонки в виде массива. Такой массив передается как строка, поэтому используйте кавычки:

{
  "type": "DataSource/MANUALINPUT",
  "declareUnsync": true,
  "hardUpdate": false,
  "settings": {
    "Data source":
  "[{\"First column\": \"First row value\", \"Second column\": \"First row value\"}, {\"First column\": \"Second row value\", \"Second column\": \"Second row value\"}]",
  "Columns order": "[\"First column\", \"Second column\"]"
  }
}

Массив strategies также возвращается через запрос https://your.polyanalyst.server:port/polyanalyst/api/v1.0/parameters/nodes. В ответе запроса вы можете увидеть описание стратегии (дополнительный параметр узла) и ее идентификатор. Например, следующие стратегии могут быть получены для узла Замена терминов:

"strategies": [
 {
   "description": "Append new rules from Parameter Node.",
   "id": 2
 },
 {
   "description": "Delete rules that are not in the Parameter Node.",
   "id": 3
 },
 {
   "description": "Update existing rules. The rules will be overwritten from the Parameter Node.",
   "id": 4
 }
]

Тело ответа (application/json)

<отсутствует>

Примеры ответов

Код Тело ответа и его описание

202

Запрос был принят к обработке. Тело ответа пустое.

500

Ошибка – указанный ID узла не существует.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Internal error – attempt to access object via null pointer"
  }
}

500

Ошибка – prjUUID является недопустимой строкой для UUID.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Failed to create UUID from string"
  }
}

500

Ошибка – указанный тип узла не найден. Данная ошибка может возникнуть, если пользователь задал в поле type несуществующий тип.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Could not find node of type 'TmlLinkTerms'"
  }
}