Version: 1.1.4

STN REST API

Краткое описание методов

Метод	Описание
GET /assistants/version	Возвращает версию сервиса Ассистент.
GET /assistants/status	Проверяет статус доступности сервиса Ассистент.
POST /assistants/answer	Сохраняет контекст ответа на поисковой запрос пользователя, затем на их основе формирует ответ пользователю.
GET /reltype/version	Возвращает версию Модуля определения типа связи.
POST /reltype/tasks	Создаёт задачу на определение типа связи.
GET /reltype/gettasks	Получает результат задачи на определение типа связи.
POST /reltype/classify	Определяет тип связи без создания задачи.
DELETE /reltype/deletetasks	Удаляет задачу на определение типа связи.
GET /semanalysis/version	Возвращает версию семантического анализа.
POST /semanalysis/documentsearch	Выявляет содержательные пересечения текстовых фрагментов документов для определения пересекающихся между собой документов.
GET /archive/version	Возвращает версию Модуля хранения.
POST /archive/QueryGetList	Получает информацию о запросах в определённом индексе.
POST /archive/favoritesQueryGetList	Получает информацию по избранным запросам в определённом индексе.
POST /archive/favoritesQueryAdd	Добавляет избранный запрос.
POST /archive/favoritesQueryDelete	Удаляет избранный запрос.
POST /archive/archiveGetList	Получает информацию об избранных запросах.
POST /archive/favoritesArchiveGetList	Получает список избранных документов.
POST /archive/favoritesArchiveAdd	Добавляет документ в Избранное.
POST /archive/favoritesArchiveDelete	Удаляет документ из Избранного.
GET /ais/version	Возвращает версию Content AI Intelligent Search.
GET /ais/status	Получает информацию об основных настройках Intelligent Search.
GET /ais/indexes	Получает информацию о списке индексов Content AI Intelligent Search.
GET /ais/indexes/indexName	Получает информацию о конкретном индексе Content AI Intelligent Search.
GET /ais/search	Задействует поиск Intelligent Service.
GET /ais/Suggestions	Возвращает подсказки в ответ на запрос.
GET /ais/getFile	Возвращает бинарный файл.
GET /info/version	Возвращает версию ProxyBack.

Получение информации о версии сервиса Ассистент

Данный метод возвращает версию сервиса Ассистент

URL

http://server:8095/

Метод

GET /assistants/version

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

Получение информации о сервисе Ассистент

Данный метод проверяет статус доступности сервиса Ассистент.

URL

http://server:8095/

Метод

GET /assistants/status

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

Вызов сервиса Ассистент

Данный метод сохраняет контекст ответа на поисковой запрос пользователя, затем на их основе формирует ответ пользователю.

URL

http://server:8095/

Метод

POST /assistants/answer

Параметры

Имя	Тип	Описание	Значение по умолчанию
guid	string	Guid входного запроса поиска для получения результатов из кеша. Может быть пустым. Используется для снижения нагрузки на поиск.	-
indexName	string	Наименование индекса, в котором необходимо осуществить поиск.	Из параметров сервера.
getContext	boolean	Возвращать ли контекст, отправляемый в сервис Ассистента?	false

Тело запроса

{
"query": "string",
  "userQuery": "string",
  "isSuggest": true,
  "resultFields": [
    "string"
  ],
  "count": 0,
  "from": 0,
  "hlFields": [
    "string"
  ],
  "id": "string",
  "position": 0,
  "__acl": [
    "string"
  ],
  "defaultSearchFields": [
    "string"
  ],
  "facets": [
    "string"
  ],
  "searchFieldsBoost": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "sort": [
    "string"
  ],
  "flags": [
    "string"
  ],
  "problemCode": "string",
  "problemDescription": "string",
  "siteUrl": "string",
  "subscribe": true,
  "reportDocumentId": "string",
  "queryAnalysisTime": 0,
  "description": "string",
  "availableHits": 0,
  "totalHits": 0,
  "totalSearchTime": 0,
  "flagAddedResultsByQuery": true
}

Описание параметров тела запроса находится в руководстве по интеграции Content AI Intelligent Search.

Ответы

Код
Описание
Тип файла
Пример

200

{
"totalHits": 1,
"resultList": [
    {
        "id": 364,
        "date": "2025-03-13T14:33:36.7596Z",
        "user": "Сергей Иванов",
        "index":{
            "answer": "Автомат — это стрелковое оружие, принятое на вооружение в СССР в 1949 году и разработанное Михаилом Тимофеевичем Калашниковым. Этот автомат, известный как АК-47, использует патрон 7,62 &times; 39 мм [2].",
            "used_context_ids": [
                0,
                1,
                2,
                3,
                4
            ],
            "source_decoding": {
                "1": "g2MWsJMBnML2wHXBUoKc",
                "2": "J2Pkr5MBnML2wHXBeIJX",
                "3": "O2Pnr5MBnML2wHXB1IIG",
                "4": "SWPwr5MBnML2wHXBPIIZ"
            },
            "fileMapping": [
                {
                    "index": 0,
                    "id": "J2Pkr5MBnML2wHXBeIJX",
                    "name": "Автомат Калашникова.pdf"
                },
                {
                    "index": 1,
                    "id": "J2Pkr5MBnML2wHXBeIJX",
                    "name": "Автомат Калашникова.pdf"
                },
                {
                    "index": 2,
                    "id": "J2Pkr5MBnML2wHXBeIJX",
                    "name": "Автомат Калашникова.pdf"
                },
                {
                    "index": 3,
                    "id": "O2Pnr5MBnML2wHXB1IIG",
                    "name": "Гослинг, Райан.pdf"
                },
                {
                    "index": 4,
                    "id": "SWPwr5MBnML2wHXBPIIZ",
                    "name": "Жириновский, Владимир Вольфович.pdf"
                },
                {
                    "index": 5,
                    "id": "g2MWsJMBnML2wHXBUoKc",
                    "name": "Сталинградская битва.pdf"
                }
            ]
        } "wiki",
        "fileId": "J2Pkr5MBnML2wHXBeIJX",
        "fileName": "Автомат Калашникова.pdf",
        "location": "/mnt/SearchStorageTest/wiki/Автомат Калашникова.pdf",
        "isDeleted": false
    },
    
]
}

Получение информации о версии Модуля определения типа связи

Данный метод возвращает версию Модуля определения типа связи

URL

http://server:8095/

Метод

GET /reltype/version

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

Создать задачу на определение типа связи

Данный метод создаёт задачу на определение типа связи.

URL

http://server:8095/

Метод

POST /reltype/tasks

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "query_text": "string",
  "found_text": "string",
  "threshold": 0,
  "uid": "string"
}

П р и м е ч а н и я

Между query_text и found_text метод устанавливает логическую связь, возвращая одно из значений в параметр result: дублирование (entailment), противоречие (contradiction) или нейтральная (neutral).
Параметр threshold - критерий выделения кандидатов на выделение связи. Чем выше значение, тем меньше вероятность получения связи, отличной от нейтральной.
Параметр uid – идентификатор пользователя, предназначен для удаления задач разлогинившегося пользователя.

Ответы

Код
Описание
Тип файла
Пример

200

{
"query_text": "Расстояние равно 10",
"found_text": "Расстояние равно 20",
"threshold": 0,
"uid": "string",
"id": "01JBGXKXNQC1RMMCV6RPZ0T3DE",
"status": "PENDING",
"result": null,
"detail": null
}

П р и м е ч а н и я

Параметр status показывает статус задачи по определению типа связи.
Параметр result содержит результат определения типа связи. Если он равен null, то нужно воспользоваться методом получения задачи по определение типа связи.
Параметр detail возвращает информацию об ошибке в обработке задачи, если задача выполнена успешно, то возвращает null.

Получить задачу по определение типа связи

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

URL

http://server:8095/

Метод

GET /reltype/gettasks

Параметры

Параметры запроса отсутствуют.

Имя	Тип	Описание	Значение по умолчанию
taskId	string	ID задачи, которое возвращается при создании задачи.	-

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

{
"query_text": "Расстояние равно 10",
"found_text": "Расстояние равно 20",
"threshold": 0,
"uid": "string",
"id": "01JBGXKXNQC1RMMCV6RPZ0T3DE",
"status": "COMPLETED",
"result": "contradiction",
"detail": null
}

П р и м е ч а н и я

Параметр status показывает статус задачи по определению типа связи.
Параметр result содержит результат определения типа связи. Если он равен null, то нужно воспользоваться методом получения задачи по определение типа связи.
Параметр detail возвращает информацию об ошибке в обработке задачи, если задача выполнена успешно, то возвращается null.

Определить тип связи

Данный метод определяет тип связи без создания задачи.

URL

http://server:8095/

Метод

POST /reltype/classify

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "query_text": "string",
  "found_text": "string",
  "threshold": 0,
  "uid": "string"
}

П р и м е ч а н и я

Между query_text и found_text метод устанавливает логическую связь, возвращая одно из значений: дублирование (entailment), противоречие (contradiction) или нейтральная (neutral).
Параметр threshold - критерий выделения кандидатов на выделение связи. Чем выше значение, тем меньше вероятность получения связи, отличной от нейтральной.
Параметр uid – идентификатор пользователя, предназначен для удаления задач разлогинившегося пользователя.

Ответы

Код
Описание
Тип файла
Пример

200

Удалить задачу по определение типа связи

Данный метод удаляет задачу на определение типа связи.

URL

http://server:8095/

Метод

DELETE /reltype/deletetasks

Параметры

Имя	Тип	Описание	Значение по умолчанию
uid	string	ID задачи, которое возвращается при создании задачи.	-

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

{
"detail": "Deleted 0 tasks with uid: \"01JBGXKXNQC1RMMCV6RPZ0T3DE\""
}

П р и м е ч а н и е

Параметр detail содержит информацию о статусе удаления задачи на определение типа связи.

Получение информации о версии семантического анализа

Данный метод возвращает версию семантического анализа

URL

http://server:8095/

Метод

GET /semanalysis/version

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

Найти похожие документы

Данный метод выявляет содержательные пересечения текстовых фрагментов документов для определения пересекающихся между собой документов.

URL

http://server:8095/

Метод

POST /semanalysis/documentsearch

Параметры

Имя	Тип	Описание	Значение по умолчанию
indexName	string	Наименование индекса, в котором надо осуществить поиск.	Указано в переменных окружения, иначе - main.

Тело запроса

{
"input": "string",
  "filters": "string",
  "resultFields": [
    "string"
  ],
  "facets": [
    {
      "facetName": "string",
      "includeFilter": "string",
      "sortBy": "string",
      "sortOrder": "string"
    }
  ],
  "percentageOfSimilarity": 0,
  "percentageDocsContains": 0,
  "topDocsToTake": 0
}

П р и м е ч а н и е

Описание параметров тела запроса находится в руководстве по интеграции Content AI Intelligent Search.

Ответы

Код
Описание
Тип файла
Пример

200

    "documents": [{
        "id": "7N4zGpMBZOHCaQmiiKrX",
        "relevance": 2047.1089,
        "body": "<em>\nСписок президентов США</em>\n\nБелый дом, официальная резиденция президента США и центр его администрации\n\nПрезидент США — глава исполнительной власти и государства США. Должность введена Конституцией США[1], принятой Конституционным конвентом (собранием) в 1787 году. Первым президентом США стал в 1789 году Джордж Вашингтон.",
        "ranges": [{
                "start": 0,
                "end": 23
            }, {
                "start": 1845,
                "end": 1864
            }
        ],
        "count": 1,
        "resultFields": {
            "createdDate": "2024-07-02T17:46:28.000+03:00",
            "filename": "Список президентов США.pdf",
            "__date_enriched": "2024-11-11T10:50:05.000+03:00",
            "__date_indexed": "2024-11-21T13:42:47.000+03:00",
            "__location": "/mnt/SearchStorageTest/tuser/Список президентов США.pdf",
            "creator": "Гаврилова Ева Макаровна",
            "extension": "pdf",
            "__date": "2024-07-02T17:46:28.000+03:00",
            "__duplicates": "JAoJV87tTo",
            "__languages": ["ru-RU"],
            "__sourceName": "FileSystem"
        }
    }
],
"facets": {
    "sourceNameFacet": [{
            "value": "FileSystem",
            "count": 1
        }
    ],
    "creatorFacet": [{
            "value": "Гаврилова Ева Макаровна",
            "count": 1
        }
    ],
    "extensionFacet": [{
            "value": "pdf",
            "count": 1
        }
    ],
    "modifiedFacet": [{
            "value": "2024.07",
            "count": 1
        }
    ],
    "languageFacet": [{
            "value": "ru-RU",
            "count": 1
        }
    ]
}
}

П р и м е ч а н и я

Параметр id возвращает идентификатор документа.
Параметр relevance получается сложением параметра score у найденных документов. Чем выше значение, тем выше релевантность.
Параметр body возвращает текст документа, в котором найденные вхождения выделены тегом em.
Параметры start и end у параметра ranges возвращают позиции найденных подстрок.
Параметр count возвращает число найденных документов.
Описание параметров, входящих в resultFields, находится в руководстве по интеграции Content AI Intelligent Search.
Параметры value и count у параметра sourceNameFacet возвращают имя источника, из которого получены документы, и количество документов в этом источнике.
Параметры value и count у параметра creatorFacet возвращают имя создателя документов, и количество документов, созданных им.
Параметры value и count у параметра extensionFacet возвращают расширение документов, и количество документов с таким расширением.
Параметры value и count у параметра modifiedFacet возвращают дату документов, и количество документов с такой датой.
Параметры value и count у параметра languageFacet возвращают язык документов, и количество документов с таким языком.

Получение информации о версии Модуля хранения

Данный метод возвращает версию Модуля хранения

URL

http://server:8095/

Метод

GET /archive/version

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

{
"ApplicationName":"Searchaiservicearchive",
"ApplicationVersion":"1.0.3"
}

Информация о выбранных запросах

Данный метод получает информацию о запросах в определённом индексе.

URL

http://server:8095/

Метод

POST /archive/QueryGetList

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "index": "string",
  "count": 0,
  "from": 0
}

П р и м е ч а н и я

Параметр index заполняется названием индекса.
Параметр count заполняется числом, равным количеству запросов, которые нужно получить.
Параметр from заполняется числом, равным порядковому номеру запроса, начиная с которого нужно получить выбранные запросы.

Ответы

Код
Описание
Тип файла
Пример

200

[{"id":13468,"date":"2024-11-01T12:37:28.306481Z","user":"TUser user","index":"gost","query":"СТО 2022"},
{"id":13467,"date":"2024-11-01T12:36:14.921582Z","user":"TUser user","index":"gost","query":"трубопровод"}]

П р и м е ч а н и я

Параметр id заполняется идентификатором запроса, удовлетворяющего параметрам отбора.
Параметр date заполняется датой создания запроса.
Параметр user заполняется логином пользователя, выполнившего запрос.
Параметр index заполняется названием индекса.
Параметр query заполняется содержимым запроса.

Список избранных запросов

Данный метод получает информацию по избранным запросам в определённом индексе для пользователя, под которым авторизована текущая сессия.

URL

http://server:8095/

Метод

POST /archive/favoritesQueryGetList

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "index": "string",
  "count": 0,
  "from": 0
}

П р и м е ч а н и я

Параметр index заполняется названием индекса.
Параметр count заполняется числом, равным количеству избранных запросов, которые нужно получить.
Параметр from заполняется числом, равным порядковому номеру избранного запроса, начиная с которого нужно получить выбранные запросы.

Ответы

Код
Описание
Тип файла
Пример

200

{
"id": 78,
"date": "2024-10-15T07:39:14.894997Z",
"user": "TUser user",
"index": "gost",
"query": "сжигание топлива"
}

П р и м е ч а н и я

Параметр id заполняется идентификатором избранного запроса.
Параметр date заполняется датой добавления запроса в избранное.
Параметр user заполняется логином пользователя, выполнившего запрос.
Параметр index заполняется названием индекса.
Параметр query заполняется содержимым запроса.

Добавить избранный запрос

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

URL

http://server:8095/

Метод

POST /archive/favoritesQueryAdd

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "index": "string",
  "query": "string"
}

П р и м е ч а н и я

Параметр index заполняется названием индекса.
Параметр query заполняется текстом избранного запроса, который нужно добавить.

Ответы

Код
Описание
Тип файла
Пример

200

Удалить избранный запрос

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

URL

http://server:8095/

Метод

POST /archive/favoritesQueryDelete

Параметры

Параметры запроса отсутствуют.

Имя	Тип	Описание	Значение по умолчанию
id	string	Идентификатор избранного запроса, который можно получить запросом информации о всех запросах.	-

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

Информация о просмотренных документах

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

URL

http://server:8095/

Метод

POST /archive/archiveGetList

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "index": "string",
  "count": 0,
  "from": 0
}

П р и м е ч а н и я

Параметр index заполняется названием индекса.
Параметр count заполняется числом, равным количеству просмотренных документов, которые нужно получить.
Параметр from заполняется числом, равным порядковому номеру просмотренного документа, начиная с которого нужно получить выбранные просмотренные документы.

Ответы

Код
Описание
Тип файла
Пример

200

{
"totalHits": 1,
"resultList": [
    {
        "id": 364,
        "date": "2025-03-13T14:33:36.7596Z",
        "user": "Сергей Иванов",
        "index": "wiki",
        "fileId": "J2Pkr5MBnML2wHXBeIJX",
        "fileName": "Автомат Калашникова.pdf",
        "location": "/mnt/SearchStorageTest/wiki/Автомат Калашникова.pdf",
        "isDeleted": false
    },
    
]
}

Список избранных документов

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

URL

http://server:8095/

Метод

POST /archive/favoritesArchiveGetList

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "index": "string",
  "count": 0,
  "from": 0
}

П р и м е ч а н и я

Параметр index заполняется названием индекса.
Параметр count заполняется числом, равным количеству избранных документов, которые нужно получить.
Параметр from заполняется числом, равным порядковому номеру избранного документа, начиная с которого нужно получить выбранные избранные документы.

Ответы

Код
Описание
Тип файла
Пример

200

{
"id": 150,
"date": "2024-10-31T14:52:58.100975Z",
"user": "TUser user",
"index": "gost",
"fileId": "kjrR15IB8N7zHhoteQQg",
"fileName": "2",
"location": "/mnt/SearchStorageTest/Moscow/2.pptx",
"isDeleted": false
}

П р и м е ч а н и я

Параметр id возвращает идентификатор избранного документа.
Параметр date возвращает дату добавления избранного документа.
Параметр user возвращает имя пользователя, добавившего избранный документ.
Параметр index возвращает название индекса, содержащего избранный документ.
Параметр fileId возвращает идентификатор файла избранного документа.
Параметр fileName возвращает название файла избранного документа.
Параметр location возвращает местоположение файла избранного документа.
Параметр isDeleted возвращает признак удаления файла.

Добавить избранный документ

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

URL

http://server:8095/

Метод

POST /archive/favoritesArchiveAdd

Параметры

Параметры запроса отсутствуют.

Тело запроса

{
  "index": "string",
  "fileId": "string",
  "fileName": "string",
  "location": "string",
  "isDeleted": true
}

П р и м е ч а н и я

Параметр index заполняется названием индекса.
Параметр fileId заполняется идентификатором файла.
Параметр fileName заполняется именем файла.
Параметр location заполняется путём к файлу.
Параметр isDeleted заполнять true.

Ответы

Код
Описание
Тип файла
Пример

200

Удалить избранный документ

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

URL

http://server:8095/

Метод

POST /archive/favoritesArchiveDelete

Параметры

Параметры запроса отсутствуют.

Имя	Тип	Описание	Значение по умолчанию
id	string	Идентификатор удаляемого избранного документа	-

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

Получение информации о версии Content AI Intelligent Search

Данный метод возвращает версию Content AI Intelligent Search

URL

http://server:8095/

Метод

GET /ais/version

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

{
"product": {
  "name": "Content AI Intelligent Search",
  "version": "5.7.0.2-linux",
  "date": "2024-05-19"
},
"components": [
  {
    "name": "Elastic",
    "version": "7.5.1"
  }
],
"OS": {
  "name": "Linux",
  "version": "5.15.0-125-generic"
},
"license": {
  "expirationDate": "2025-06-30T00:00:00",
  "searchIndexDocsCount": 2000,
  "searchUsersCount": 25,
  "searchActiveUsersCount": 3,
  "expirationTime": "2025-06-30T00:00:00"
}
}

Информация об основных настройках Intelligent Search

Данный метод получает информацию об основных настройках Intelligent Search.

URL

http://server:8095/

Метод

GET /ais/status

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

[
{
"index": "gost",
"sources": [
  {
    "sourceName": "FileSystem",
    "crawlingStatus": "completed",
    "crawlStartTime": "2025-04-10T10:22:28+03:00",
    "crawlFinishTime": "2025-04-10T10:22:34+03:00",
    "lastCrawlTotalTime": "0s",
    "crawlingNode": "st-ubuntu-02",
    "docsCrawled": 16,
    "docsCrawledNew": 0,
    "docsSkipped": 0,
    "docsDeleted": 0,
    "crawlingErrors": 0,
    "docsProcessedSuccessfully": 0,
    "docsProcessedWithErrors": 0,
    "docsProcessingFailed": 0,
    "docsIndexedSuccessfully": 0,
    "docsIndexingFailed": 0,
    "nextCrawlTime": "2025-04-11T10:22:28+03:00"
  }
]
},
{
"index": "wiki",
"sources": [
  {
    "sourceName": "FileSystem",
    "crawlingStatus": "completed",
    "crawlStartTime": "2025-04-10T10:31:59+03:00",
    "crawlFinishTime": "2025-04-10T10:32:05+03:00",
    "lastCrawlTotalTime": "0s",
    "crawlingNode": "st-ubuntu-02",
    "docsCrawled": 116,
    "docsCrawledNew": 0,
    "docsSkipped": 1,
    "docsDeleted": 0,
    "crawlingErrors": 0,
    "docsProcessedSuccessfully": 0,
    "docsProcessedWithErrors": 0,
    "docsProcessingFailed": 0,
    "docsIndexedSuccessfully": 0,
    "docsIndexingFailed": 0,
    "nextCrawlTime": "2025-04-11T10:32:59+03:00"
  }
]

П р и м е ч а н и е

Описание параметров тела ответа находится в руководстве по интеграции Content AI Intelligent Search.

Информация о списке индексов

Данный метод получает список индексов Intelligent Search.

URL

http://server:8095/

Метод

GET /ais/indexes

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

[
{
"index": "wiki"
},
{
"index": "gost"
}
]

Получение информации о конкретном индексе Content AI Intelligent Search.

Данный метод получает информацию о конкретном выбранном индексе.

URL

http://server:8095/

Метод

GET /ais/indexes/indexName

Параметры

Имя	Тип	Описание	Значение по умолчанию
indexName	string	Наименование индекса, в котором необходимо осуществить поиск.	Из параметров сервера.

Тело запроса

{
  "index": "gost",
  "fields": [
    {
      "field": "body",
      "type": "String",
      "indexType": "Semantic",
      "sorted": false,
      "isArray": false,
      "updateUsingRegex": [],
      "similarSearch": {
        "enabled": true
      },
      "promotedResults": {
        "enabled": false
      },
      "synonyms": {
        "enabled": true,
        "applyWhileIndexing": false,
        "dictionaries": []
      },
      "characterNormalization": {
        "enabled": false
      },
      "queryCorrection": {
        "enabled": true,
        "useAsSource": true,
        "maxTokensCount": 300
      },
      "urlDecoding": {
        "enabled": false
      },
      "addHyperlinks": [
        {
          "order": 1,
          "addLinksOn": "Synonyms"
        }
      ],
      "systemField": false
    }]
}

П р и м е ч а н и е

Описание параметров тела запроса находится в руководстве по интеграции Content AI Intelligent Search.

Ответы

Код
Описание
Тип файла
Пример

200

[{}]

Поиск Intelligent Search

Данный метод задействует поиск Intelligent Service.

URL

http://server:8095/

Метод

GET /ais/search

Параметры

Имя	Тип	Описание	Значение по умолчанию
indexName	string	Имя индекса	Из переменных окружения.

Тело запроса

{
  "query": "string",
  "userQuery": "string",
  "isSuggest": true,
  "resultFields": [
    "string"
  ],
  "count": 0,
  "from": 0,
  "hlFields": [
    "string"
  ],
  "id": "string",
  "position": 0,
  "__acl": [
    "string"
  ],
  "defaultSearchFields": [
    "string"
  ],
  "facets": [
    "string"
  ],
  "searchFieldsBoost": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  },
  "sort": [
    "string"
  ],
  "flags": [
    "string"
  ],
  "problemCode": "string",
  "problemDescription": "string",
  "siteUrl": "string",
  "subscribe": true,
  "reportDocumentId": "string",
  "queryAnalysisTime": 0,
  "description": "string",
  "availableHits": 0,
  "totalHits": 0,
  "totalSearchTime": 0,
  "flagAddedResultsByQuery": true
}

П р и м е ч а н и е

Детальное описание параметров тела запроса смотрите в Content AI Intelligent Search - Руководство по интеграции.

Ответы

Код
Описание
Тип файла
Пример

200

{
"totalSearchTime": 65,
"queryAnalysisTime": 4,
"indexSearchTime": 61,
"totalHits": 1,
"availableHits": 1,
"hits": [
{
  "relevance": 19777.47,
  "id": "5Dow2JIB8N7zHhot0gV_",
  "resultFields": {
    "createdDate": "2022-08-19T10:23:47+03:00",
    "filename": "СТО ИНТИ S.10.3-2022 Rus.pdf",
    "__date_enriched": "2024-10-29T15:12:11+03:00",
    "__date_indexed": "2024-10-29T15:12:11+03:00",
    "__location": "/mnt/SearchStorageTest/Moscow/СТО ИНТИ S.10.3-2022 Rus.pdf",
    "creator": "Рогозов Алексей Алексеевич",
    "extension": "pdf",
    "__date": "2024-09-27T11:42:25.323+03:00",
    "__duplicates": "dll7N9736Y",
    "__languages": [
      "ru-RU"
    ],
    "__sourceName": "FileSystem"
  },
  "hlFields": {
    "body": [
      "Общие технические условия<em>СТО ИНТИ S.10.3-2022</em> Издание официальное. Лист данных дозировочных насосов<em>СТО ИНТИ S.10.3-2022</em>
    ]
  }
}
],
"facets": {
"lastAuthorFacet": [],
"sourceNameFacet": [
  {
    "value": "FileSystem",
    "count": 1
  }
],
"modifiedFacet": [
  {
    "value": "2024.09",
    "count": 1
  }
],
"languageFacet": [
  {
    "value": "ru-RU",
    "count": 1
  }
],
"extensionFacet": [
  {
    "value": "pdf",
    "count": 1
  }
],
"creatorFacet": [
  {
    "value": "Рогозов Алексей Алексеевич",
    "count": 1
  }
]
},
"guid": "315579f0-751b-42a8-b932-67d8d63cc86a"
}

П р и м е ч а н и е

Описание параметров тела ответа находится в руководстве по интеграции Content AI Intelligent Search.

Отображение подсказок при вводе запроса

Данный метод возвращает подсказки в ответ на запрос.

URL

http://server:8095/

Метод

GET /ais/Suggestions

Параметры

Параметры запроса отсутствуют.

Имя	Тип	Описание	Значение по умолчанию
indexName	string	Имя индекса	Из переменных окружения.

Тело запроса

{
  "query": "string",
  "maxCount": 0
}

П р и м е ч а н и я

Параметр query заполняется текстом запроса, к которому нужны подсказки.
Параметр maxCount заполняется числом, ограничивающим максимальное количество подсказок.

Ответы

Код
Описание
Тип файла
Пример

200

{
"totalSearchTime": 7,
"suggestions": [
    {
        "query": "какой диаметр условного прохода у стальных <em>труб?</em>",
        "count": 315,
        "source": "searchQuery"
    }
]
}

П р и м е ч а н и е

Описание параметров тела ответа находится в руководстве по интеграции Content AI Intelligent Search.

Скачивание файла

Данный метод возвращает бинарный файл.

URL

http://server:8095/

Метод

GET /ais/getFile

Параметры

Параметры запроса отсутствуют.

Имя	Тип	Описание	Значение по умолчанию
docId	string	Идентификатор файла Intelligent Search	-
fileName	string	Имя файла для скачивания с расширением	file
indexName	string	Наименование индекса	Из переменных окружения.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Тип файла
Пример

200

Получение информации о версии ProxyBack

Данный метод возвращает версию ProxyBack

URL

http://server:8095/

Метод

GET /info/version

Параметры

Параметры запроса отсутствуют.

Тело запроса

Тело запроса отсутствует.

Ответы

Код
Описание
Пример

200

{
"ApplicationName": "Searchaiservice",
"ApplicationVersion": "1.0.3"
}

Краткое описание методов​

Получение информации о версии сервиса Ассистент​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

Получение информации о сервисе Ассистент​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

Вызов сервиса Ассистент​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

Получение информации о версии Модуля определения типа связи​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

Создать задачу на определение типа связи​

URL​

Метод​

Параметры​

Тело запроса​

П р и м е ч а н и я​

Ответы​

П р и м е ч а н и я​

Получить задачу по определение типа связи​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

П р и м е ч а н и я​

Определить тип связи​

URL​

Метод​

Параметры​

Тело запроса​

П р и м е ч а н и я​

Ответы​

Удалить задачу по определение типа связи​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

П р и м е ч а н и е​

Получение информации о версии семантического анализа​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

Найти похожие документы​

URL​

Метод​

Параметры​

Тело запроса​

П р и м е ч а н и е​

Ответы​

П р и м е ч а н и я​

Получение информации о версии Модуля хранения​

URL​

Метод​

Параметры​

Тело запроса​

Ответы​

Информация о выбранных запросах​

URL​

Метод​

Параметры​

Тело запроса​

П р и м е ч а н и я​

Краткое описание методов

Получение информации о версии сервиса Ассистент

URL

Метод

Параметры

Тело запроса

Ответы

Получение информации о сервисе Ассистент

URL

Метод

Параметры

Тело запроса

Ответы

Вызов сервиса Ассистент

URL

Метод

Параметры

Тело запроса

Ответы

Получение информации о версии Модуля определения типа связи

URL

Метод

Параметры

Тело запроса

Ответы

Создать задачу на определение типа связи

URL

Метод

Параметры

Тело запроса

П р и м е ч а н и я

Ответы

П р и м е ч а н и я

Получить задачу по определение типа связи

URL

Метод

Параметры

Тело запроса

Ответы

П р и м е ч а н и я

Определить тип связи

URL

Метод

Параметры

Тело запроса

П р и м е ч а н и я

Ответы

Удалить задачу по определение типа связи

URL

Метод

Параметры

Тело запроса

Ответы

П р и м е ч а н и е

Получение информации о версии семантического анализа

URL

Метод

Параметры

Тело запроса

Ответы

Найти похожие документы

URL

Метод

Параметры

Тело запроса

П р и м е ч а н и е

Ответы

П р и м е ч а н и я

Получение информации о версии Модуля хранения

URL

Метод

Параметры

Тело запроса

Ответы

Информация о выбранных запросах

URL

Метод

Параметры

Тело запроса

П р и м е ч а н и я