platform/agent_api
5
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

#7 Добавить основные модели ивентов агента. Обоновлена документация в соответствии с иветами агента

Browse source
This commit is contained in:
Ярослав Малинин 2026-04-08 10:47:24 +03:00
parent f300b4c6fb
commit 7aa0f80d4f
1 changed files with 99 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

113
README.md
View file

@ -105,37 +105,97 @@ async def on_telegram_message(from_user: int, text: str):
} }
``` ```
#### AGENT_EVENT #### AGENT_EVENT_TEXT_CHUNK
Базовый класс для ивентов, которые стримит агент во время генерации ответа. Конкретный класс для ивента определяется по `subtype`.
##### TEXT_CHUNK
Чанк текста ответа агента. Чанк текста ответа агента.
```json ```json
{ {
"type": "AGENT_EVENT", "type": "AGENT_EVENT_TEXT_CHUNK",
"subtype": "TEXT_CHUNK", "text": "Фрагмент текста",
"text": "Фрагмент текста" "source": "main"
} }
``` ```
##### END | Поле | Тип | Описание |
|--------|--------|-----------------------------------------------|
| type | string | Всегда `AGENT_EVENT_TEXT_CHUNK` |
| text | string | Фрагмент текста ответа агента |
| source | string | Источник события (по умолчанию "main") |
#### AGENT_EVENT_TOOL_CALL_CHUNK
Агент решил использовать инструмент и генерирует аргументы.
```json
{
"type": "AGENT_EVENT_TOOL_CALL_CHUNK",
"tool_name": "имя_инструмента",
"args_chunk": "{\"key\": \"value\"}",
"source": "main"
}
```
| Поле | Тип | Описание |
|-------------|---------|-----------------------------------------------|
| type | string | Всегда `AGENT_EVENT_TOOL_CALL_CHUNK` |
| tool_name | string | Имя инструмента (может быть null в первом чанке) |
| args_chunk | string | Кусок JSON-аргументов (может быть null) |
| source | string | Источник события (по умолчанию "main") |
#### AGENT_EVENT_TOOL_RESULT
Инструмент отработал и вернул результат.
```json
{
"type": "AGENT_EVENT_TOOL_RESULT",
"tool_name": "имя_инструмента",
"result": "результат выполнения",
"source": "main"
}
```
| Поле | Тип | Описание |
|------------|--------|-----------------------------------------------|
| type | string | Всегда `AGENT_EVENT_TOOL_RESULT` |
| tool_name | string | Имя инструмента |
| result | any | Результат выполнения (строка, объект или массив) |
| source | string | Источник события (по умолчанию "main") |
#### AGENT_EVENT_CUSTOM_UPDATE
Кастомный прогресс (например, скачивание файла) изнутри инструмента.
```json
{
"type": "AGENT_EVENT_CUSTOM_UPDATE",
"payload": {"status": "in_progress", "progress": 50},
"source": "main"
}
```
| Поле | Тип | Описание |
|----------|-----------------|-----------------------------------------------|
| type | string | Всегда `AGENT_EVENT_CUSTOM_UPDATE` |
| payload | object | Любые данные о прогрессе |
| source | string | Источник события (по умолчанию "main") |
#### AGENT_EVENT_END
Агент закончил генерацию ответа. Агент закончил генерацию ответа.
```json ```json
{ {
"type": "AGENT_EVENT", "type": "AGENT_EVENT_END",
"subtype": "END",
"tokens_used": 42 "tokens_used": 42
} }
``` ```
| Поле | Тип | Описание | | Поле | Тип | Описание |
|-------------|--------|-----------------------| |-------------|--------|-----------------------------------------------|
| tokens_used | int | Количество использованных токенов | | type | string | Всегда `AGENT_EVENT_END` |
| tokens_used | int | Количество использованных токенов |
#### ERROR #### ERROR
@ -164,4 +224,29 @@ async def on_telegram_message(from_user: int, text: str):
} }
``` ```
Неопределенная ошибка в работе агента.
```json
{
"type": "ERROR",
"code": "error_code",
"details": "Описание ошибки"
}
```
| Поле | Тип | Описание |
|---------|-------|----------------|
| code | string | Код ошибки |
| details | string | Подробности |
#### GRACEFUL_DISCONNECT
Отправляется перед завершением работы контейнера с агентом. Например, при долгом бездействии. Нужно, чтобы отделять обрыв соединения из-за ошибки с необходимостью повторного подключения. Приход этого сообщения означает, что агент осознанно завершает работу с клиентом по какой-то причине. Для дальнейшего взаимодействия нужно снова обратиться к мастеру.
```json
{
"type": "GRACEFUL_DISCONNECT"
}
```
![Схема взаимодействия](docs/schema.png) ![Схема взаимодействия](docs/schema.png)