AIAgent
AI-агент, помогающий сформировать запрос к YandexGPT.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
agentConfig |
AIAgentConfig | Да | Нет | Нет | Настройки AI-агента. |
tasks |
AIAgentTask[] | Да | Нет | Нет | Задачи, которые должен выполнить AI-агент. |
Объект AIAgentConfig
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
goal |
string |
Да | Нет | Да | Индивидуальная цель, которой руководствуется AI-агент при принятии решений. Например: «помочь с выбором автозапчастей для указанного автомобиля». |
role |
string |
Да | Нет | Да | Роль, которая определяет функции и опыт AI-агента. Например: «консультант по выбору автозапчастей». |
backstory |
string |
Нет | Нет | Да | Предыстория, которая определяет индивидуальность AI-агента и обогащает контекст. Например: «ты находишь лучшие автозапчасти по соотношению цены и качества и кратко объясняешь свой выбор». |
model |
AIAgentModel | Нет | Нет | Нет | Большая языковая модель, которая будет использоваться AI-агентом. |
knowledgeSources |
KnowledgeSource[] | Нет | Нет | Нет | Источники знаний AI-агента. |
tools |
AIAgentTool[] | Нет | Нет | Нет | Инструменты, которые AI-агент может использовать, чтобы получать дополнительные данные для формирования ответа. |
Объект AIAgentTask
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
description |
string |
Да | Нет | Да | Описание задачи, которую должен выполнить AI-агент. Например: «подбери масляный фильтр для LADA Granta». |
result |
string |
Нет | Нет | Да | Описание вида ожидаемого результата. Например: «список адресов магазинов, где можно купить подходящие автозапчасти». |
Объект AIAgentModel
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
name |
string |
Нет | yagpt |
Нет | Имя модели. Список доступных моделей. |
Объект KnowledgeSource
Поля textSource и fileSource — взаимоисключающие, можно использовать только одно из них.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
textSource |
TextKnowledgeSource | Нет | Нет | Нет | Источник знаний в виде текста. |
fileSource |
FileKnowledgeSource | Нет | Нет | Нет | Источник знаний в виде файла. |
Объект TextKnowledgeSource
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
content |
string |
Да | Нет | Да | Текст, который содержит источник знаний. |
Объект FileKnowledgeSource
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
type |
string |
Да | Нет | Нет | Тип файла, который содержит источник знаний. Доступные типы: TEXT, JSON, CSV, PDF, EXCEL. |
dataSource |
DataSource | Да | Нет | Нет | Источник данных. |
Объект DataSource
Поля urlSource и objectStorageSource — взаимоисключающие, можно использовать только одно из них.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
urlSource |
UrlDataSource | Нет | Нет | Нет | Файл, который доступен по публичному URL. |
objectStorageSource |
ObjectStorageDataSource | Нет | Нет | Нет | Файл, который находится в бакете Object Storage. |
Объект UrlDataSource
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
url |
string |
Да | Нет | Да | Публичный URL. |
Объект ObjectStorageDataSource
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
bucket |
string |
Да | Нет | Нет | Имя бакета, в котором находится файл. |
object |
string |
Да | Нет | Да | Имя объекта, в котором находится файл, например prefix/subprefix/data.json. |
Объект AIAgentTool
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
mcpServer |
MCPServer | Нет | Нет | Нет | MCP-сервер. |
Объект MCPServer
Поля useServiceAccount и token — взаимоисключающие, можно использовать только одно из них.
|
Имя поля |
Тип |
Обязательное |
Значение по умолчанию |
Поддерживается шаблонизация |
Описание |
|
|
|
Да |
Нет |
Нет |
URL, по которому доступен MCP-сервер. Например: |
|
|
|
Да |
Нет |
Нет |
Тип транспортного механизма, который будет использоваться для взаимодействия с MCP-сервером. Доступные типы:
|
|
|
|
Нет |
Нет |
Нет |
Если задано значение:
|
|
|
|
Нет |
Нет |
Нет |
OAuth-токен, который будет использоваться для авторизации на MCP-сервере. |