Описание программы для ЭВМ Boring ML и пользовательская инструкция

1. Термины и определения
Программа – программа для ЭВМ Boring ML, правообладателем которой является Общество с ограниченной ответственностью «Большие Методы» (ИНН 7805816130).
Пользователь – лицо, на законных основаниях использующее Программу.
Клиент – потенциальный приобретатель товаров, работ, услуг Пользователя.
Идентификатор Клиента – потенциально любой уникальный идентификатор Клиента (номер телефона, адрес электронной почты, ID и т.п.), поддерживаемый существующими интеграциями Программы.
Скор-балл (Индекс) – числовое значение, рассчитанное в диапазоне от 0 то 1, которое возвращает Программа в зависимости от Модели, которую использует Пользователь при эксплуатации Программы.
Модель – аналитический алгоритм, который может быть запущен в ПО на основании обучающей выборки, предоставленной Пользователем.
Обучающая выборка – множество Идентификаторов Клиента, размеченное по логике бинарной классификации, содержащее положительные и отрицательные примеры Идентификаторов, соответствующие Задаче, которую должна решать Модель, запускаемая в Программе.
Задачи Модели – перечень прикладных применений Моделей, запускаемых в ПО, включая, но не ограничиваясь:
- прогнозирование вероятности отклика Клиента Пользователя на рекламное предложение Пользователя;
- прогнозирование вероятности дозвона по номеру телефона Клиента Пользователя;
- прогнозирование вероятности возврата кредита/займа Клиентом Пользователя;
- прогнозирование риска мошеннических намерений при регистрации Клиента Пользователя.
SFTP – протокол прикладного уровня передачи файлов, работающий поверх безопасного канала/ Предназначен для копирования и выполнения других операций с файлами поверх надёжного и безопасного соединения

2. Функциональные возможности Программы
Программа предназначена для осуществления расчета Индекса с применением Моделей (одной или нескольких) на основании данных, агрегируемых дата-партнерами Правообладателя и/или Пользователем.
Модель подготавливается Правообладателем, исходя из Задачи, сообщенной Пользователем.
Правообладателем реализована возможность расчета Индексов при использовании абонентских номеров телефонов сотовой сети (DEF-номеров) в качестве Идентификатора Клиента. Возможность использования иных идентификаторов технологически заложена в архитектуру Программы, но находится в стадии тестирования и в настоящий момент не предоставляется в составе базового доступа к Программе.

3. Порядок использования Программы
3.1. Порядок направления запросов в Программу
3.1.1 Авторизация пользователя при направлении запроса
Авторизация пользователя происходит через Basic Auth (передача учетных данных пользователя (логина и пароля), закодированного в формат Base64, в заголовке HTTP-запроса). Структура заголовка, в котором передаются учетные данные пользователя в формате:
Authorization: Basic <base64-encoded-credentials>
Пример (соответствует логину и паролю в формате «user:password»):
Authorization: Basic dXNlcjpwYXNzd29yZA==
В случае некорректных учетных данных пользователя или их непредоставления, сервер отвечает с кодом состояния 401 Unauthorized и заголовком WWW-Authenticate: Basic.

3.1.2. Синтаксис запросов, направляемых в Программу
Направление запросов в Программу осуществляется посредством API-интерфейса Программы. HTTP POST запрос отправляется по URL 82.202.137.18:9000/api/v1/score.

Структура запроса:
{
curl --location ' 82.202.137.18:9000/api/v1/score'
--header 'Content-Type: application/json'
--header 'Authorization: Basic dXNlcjpwYXNzd29yZA=='
--data '{
"msisdn": [msisdn],
"model":"model1"
}'

где model – это идентификатор конкретной Модели, применяемой для расчета Индекса; msisdn – идентификатор Клиента.

Направление запросов может осуществляться средствами базовых командных строк/консолей операционных систем Windows (начиная с версии 10), MacOS или Linux (иных UNIX-подобных операционных систем), либо с использованием сторонних программ, поддерживающих направление сURL запросов.

Дорожная карта развития Программы предполагает появление возможности направления запросов в Программу путём загрузки списка имеющихся у Пользователя Идентификаторов Клиента в формате .csv файла, в котором каждый новый Идентификатор начинается с новой строчки, на SFTP-сервер, задаваемый Правообладателем в Программе по согласованию с Пользователем, либо на согласованный с Пользователем файлообменный сервис.

3.2. Порядок получения ответов Программы
Получение ответов от Программы осуществляется посредством API-интерфейса Программы в виде ответа на POST запрос Пользователя.

Структура ответа:
Успешный ответ: (код состояния 200 OK) - {"msisdn":msisdn],"value":[value]}
где msisnd – идентификатор Клиента, по которому был рассчитан Индекс, а value – значение рассчитанного Индекса;
Ошибка авторизации: код состояния 401 Unauthorized
Ошибка на стороне сервера: код состояния 500 Internal server error { "Error during scoring request"}
Ошибка при формировании запроса на стороне клиента: код состояния 422 Unprocessable entity

Дорожная карта развития Программы предполагает появление возможности получения ответов Программы путём их выгрузки в формате .csv файла на SFTP-сервер, задаваемый Правообладателем в Программе по согласованию с Пользователем, либо на согласованный с Пользователем файлообменный сервис.

4. Поддержка Программы и прочие сведения
Запросы Пользователей при возникновении сбоев и ошибок в работе Программы принимаются посредством электронной почты по следующему адресу: techno@bigmethods.ru.
С текстом Лицензионного соглашения Правообладателя с конечным пользователем можно ознакомиться по ссылке http://82.202.137.18:9000/docs/licenses.
С текстом уведомлений, сопровождающих Программу, можно ознакомиться по ссылке http://82.202.137.18:9000/docs/notice.