mlops_platform/documentation
7
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity

Fix app name in api doc

Browse source
This commit is contained in:
Georgii Zhulikov 2025-05-29 16:35:25 +03:00
parent 77ed7a77f4
commit 3a25155fb1
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
pages/api-module.md
View file

@ -7,16 +7,16 @@
- [Общая работа с пайплайнами](#общая-работа-с-пайплайнами) - [Общая работа с пайплайнами](#общая-работа-с-пайплайнами)
- [Отдельный пайплайн](#отдельный-пайплайн) - [Отдельный пайплайн](#отдельный-пайплайн)
Все API запросы работают по ссылкам вида `https://platform.stratpro.hse.ru/app-name/<api>`. Все API запросы работают по ссылкам вида `https://platform.stratpro.hse.ru/pu-username-pa-appname/<api>`.
Здесь `app-name` - название приложения, оно же указано в пункте `namespace` во всех компонентах приложения. Здесь `pu-username-pa-appname` - название приложения, оно же указано в пункте `namespace` во всех компонентах приложения.
## Файловый API ## Файловый API
### Работа с файловым API ### Работа с файловым API
URL запросов к файловому API имеют вид `https://platform.stratpro.hse.ru/app-name/files/box-name/<path>`. URL запросов к файловому API имеют вид `https://platform.stratpro.hse.ru/pu-username-pa-appname/files/box-name/<path>`.
Здесь `box-name` - это имя компонента DataBox, к которому обращается запрос. Здесь `box-name` - это имя компонента DataBox, к которому обращается запрос.
@ -37,12 +37,12 @@ URL запросов к файловому API имеют вид `https://platfo
Для загрузки файла можно использовать следующий запрос `PUT`: Для загрузки файла можно использовать следующий запрос `PUT`:
```sh ```sh
curl -X PUT https://platform.stratpro.hse.ru/app-name/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:<password>" curl -X PUT https://platform.stratpro.hse.ru/pu-username-pa-appname/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:<password>"
``` ```
Это запрос: Это запрос:
1. К приложению `app-name`. 1. К приложению `pu-username-pa-appname`.
2. К файловому API (у которого endpoint всегда `files`). 2. К файловому API (у которого endpoint всегда `files`).
3. К ящику `box-name`. 3. К ящику `box-name`.
4. К пути `my_dir/my_file.txt` внутри ящика. 4. К пути `my_dir/my_file.txt` внутри ящика.
@ -52,7 +52,7 @@ curl -X PUT https://platform.stratpro.hse.ru/app-name/files/box-name/my_dir/my_f
```json ```json
{ {
"name": "app-name/files/box-name/my_dir/my_file.txt", "name": "pu-username-pa-appname/files/box-name/my_dir/my_file.txt",
"presigned_put_url": "<Длинная pre-signed ссылка загрузки>" "presigned_put_url": "<Длинная pre-signed ссылка загрузки>"
} }
``` ```
@ -71,14 +71,14 @@ curl -X PUT -T local/path/to/my_file.txt "<Длинная pre-signed ссылк
Для скачивания нужно сделать запрос такого же формата, как для загрузки файла, но запрос GET. Для скачивания нужно сделать запрос такого же формата, как для загрузки файла, но запрос GET.
```sh ```sh
curl -X GET https://platform.stratpro.hse.ru/app-name/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:<password>" curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/files/box-name/my_dir/my_file.txt -H "Content-Type: application/json" -u "developer:<password>"
``` ```
Ответ такой же, как при загрузке - pre-signed ссылка в формате json, но теперь на скачивание. Ответ такой же, как при загрузке - pre-signed ссылка в формате json, но теперь на скачивание.
```json ```json
{ {
"name": "app-name/files/box-name/my_dir/my_file.txt", "name": "pu-username-pa-appname/files/box-name/my_dir/my_file.txt",
"presigned_get_url": "<Длинная pre-signed ссылка скачивания>" "presigned_get_url": "<Длинная pre-signed ссылка скачивания>"
} }
``` ```
@ -87,14 +87,14 @@ GET-запрос к файловой группе возвращает спис
```json ```json
{ {
"name": "app-name/files/box-name/my_dir/", "name": "pu-username-pa-appname/files/box-name/my_dir/",
"files": [ "files": [
{ {
"name": "app-name/files/box-name/my_dir/file1.png", "name": "pu-username-pa-appname/files/box-name/my_dir/file1.png",
"presigned_get_url": "<Длинная pre-signed ссылка скачивания>" "presigned_get_url": "<Длинная pre-signed ссылка скачивания>"
}, },
{ {
"name": "app-name/files/box-name/my_dir/file2.txt", "name": "pu-username-pa-appname/files/box-name/my_dir/file2.txt",
"presigned_get_url": "<Длинная pre-signed ссылка скачивания>" "presigned_get_url": "<Длинная pre-signed ссылка скачивания>"
} }
] ]
@ -108,7 +108,7 @@ ML-компоненты проводят расчёты при получени
Каждый развёрнутый ML-компонент содержит OpenAPI спецификацию с информацией о себе. Её можно получить следующим запросом: Каждый развёрнутый ML-компонент содержит OpenAPI спецификацию с информацией о себе. Её можно получить следующим запросом:
``` ```
curl -X GET https://platform.stratpro.hse.ru/app-name/API_NAME/modelversion -H "Content-Type: application/json" -u "<username>:<password>" curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/API_NAME/modelversion -H "Content-Type: application/json" -u "<username>:<password>"
``` ```
Тело запроса на выполнения расчёта - это объект с полями, которые в точности копируют поля из функции inference в [MLComponent](mlcmp.md#функция-inference). Тело запроса на выполнения расчёта - это объект с полями, которые в точности копируют поля из функции inference в [MLComponent](mlcmp.md#функция-inference).
@ -153,7 +153,7 @@ curl -X GET https://platform.stratpro.hse.ru/app-name/API_NAME/modelversion -H "
Запрос, с файлом `data.json` в его теле и базовой аутентификацией. Запрос, с файлом `data.json` в его теле и базовой аутентификацией.
``` ```
curl -X POST -d @data.json https://platform.stratpro.hse.ru/app-name/API_NAME/predict -H "Content-Type: application/json" -u "<username>:<password>" curl -X POST -d @data.json https://platform.stratpro.hse.ru/pu-username-pa-appname/API_NAME/predict -H "Content-Type: application/json" -u "<username>:<password>"
``` ```
@ -162,19 +162,19 @@ curl -X POST -d @data.json https://platform.stratpro.hse.ru/app-name/API_NAME/pr
Каждый развёрнутый пайплайн содержит OpenAPI спецификацию запросов к себе. Её можно получить следующим запросом: Каждый развёрнутый пайплайн содержит OpenAPI спецификацию запросов к себе. Её можно получить следующим запросом:
``` ```
curl -X GET https://platform.stratpro.hse.ru/app-name/pipelines/PIPELINE_NAME/version -H "Content-Type: application/json" -u "<username>:<password>" curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/pipelines/PIPELINE_NAME/version -H "Content-Type: application/json" -u "<username>:<password>"
``` ```
Основная работа происходит с конкретными пайплайнами. Из общих команд полезны: Основная работа происходит с конкретными пайплайнами. Из общих команд полезны:
``` ```
# Получить список пайплайнов # Получить список пайплайнов
curl -X GET https://platform.stratpro.hse.ru/app-name/pipelines -H "Content-Type: application/json" -u "<username>:<password>" curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/pipelines -H "Content-Type: application/json" -u "<username>:<password>"
``` ```
``` ```
# Получить список запусков пайплайнов # Получить список запусков пайплайнов
curl -X GET https://platform.stratpro.hse.ru/app-name/trials -H "Content-Type: application/json" -u "<username>:<password>" curl -X GET https://platform.stratpro.hse.ru/pu-username-pa-appname/trials -H "Content-Type: application/json" -u "<username>:<password>"
``` ```
## Отдельный пайплайн ## Отдельный пайплайн
@ -186,7 +186,7 @@ curl -X GET https://platform.stratpro.hse.ru/app-name/trials -H "Content-Type: a
``` ```
curl -X POST -d @data.json https://platform.stratpro.hse.ru/app-name/pipelines/PIPELINE_NAME/trials -H "Content-Type: application/json" -u "<username>:<password>" curl -X POST -d @data.json https://platform.stratpro.hse.ru/pu-username-pa-appname/pipelines/PIPELINE_NAME/trials -H "Content-Type: application/json" -u "<username>:<password>"
``` ```
Тело запроса на выполнения расчёта - это объект с полями, похожими на поля запроса к MLComponent. Тело запроса на выполнения расчёта - это объект с полями, похожими на поля запроса к MLComponent.