Natural Data Access API

openapi: 3.0.0
info:
    title: Natural Data Access API
    version: 1.0.0
    description: Сервис доступа к данным на естественном языке

servers:
- url: https://brain-guard.ru

paths:
/
post:
    summary: Обработать запрос
    requestBody:
    required: true
    content:
    application/json:
    schema:
    $ref: '#/components/schemas/main'
    responses:
        '200':
        description: Запрос обработан
        content:
        application/json:
        schema:
        $ref: '#/components/schemas/mainresponse'
        '400':
        description: Некорректный запрос
        '500':
        description: Внутренняя ошибка сервера

components:
schemas:
    main:
    type: object
    properties:
        userkey:
        type: string
        cfname:
        type: string
        userquery:
        type: string
        prepromt:
        type: string
        usermap:
        type: object
    required:
    - userkey

    mainresponse:
    type: object
    properties:
        status:
        type: string
        text:
        type: string

У запроса одно обязательное свойство: userkey. Если передать только его, будет выполнена проверка наличия и активности переданного пользовательского ключа и выдан результат проверки.

Чтобы получить ответ на вопрос пользователя, надо задать свойство userquery. Вместе с этим свойством должно быть передано имя предопределенного источника (cfname) или схема таблиц и правила преобразования (prepromt и usermap соответственно)