AIAgent
Written by
Updated at October 20, 2025
AI agent to help you put together your prompt to YandexGPT.
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
agentConfig | 
AIAgentConfig | Yes | No | No | AI agent settings. | 
tasks | 
AIAgentTask[] | Yes | No | No | Tasks the AI agent has to complete. | 
AIAgentConfig object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
goal | 
string | 
Yes | No | Yes | Individual goal that guides the AI agent's decision-making, e.g., help with choice of parts for the specified vehicle. | 
role | 
string | 
Yes | No | Yes | Role that defines the AI agent's functions and experience, e.g., car parts consultant. | 
backstory | 
string | 
No | No | Yes | Backstory defining the AI agent's personality and enriching the context, e.g., you find the best value for money car parts and briefly explain your choice. | 
model | 
AIAgentModel | No | No | No | LLM the AI agent will use. | 
knowledgeSources | 
KnowledgeSource[] | No | No | No | AI agent’s knowledge sources. | 
tools | 
AIAgentTool[] | No | No | No | Tools for your AI agent to use for obtaining external data when generating a response. | 
AIAgentTask object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
description | 
string | 
Yes | No | Yes | Description of the task you want the AI agent to perform, e.g., find an oil filter for a BMW 320i. | 
result | 
string | 
No | No | Yes | Description of what you expect to get, e.g., a list of addresses of stores selling the car parts you need. | 
AIAgentModel object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
name | 
string | 
No | yagpt | 
No | Model name. List of available models. | 
KnowledgeSource object
The textSource and fileSource fields are mutually exclusive: you can use only one of them.
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
textSource | 
TextKnowledgeSource | No | No | No | Text-based knowledge source. | 
fileSource | 
FileKnowledgeSource | No | No | No | File-based knowledge source. | 
TextKnowledgeSource object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
content | 
string | 
Yes | No | Yes | Text containing a knowledge source. | 
FileKnowledgeSource object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
type | 
string | 
Yes | No | No | File type containing a knowledge source. Available types: TEXT, JSON, CSV, PDF, EXCEL. | 
dataSource | 
DataSource | Yes | No | No | Data source: | 
DataSource object
The urlSource and objectStorageSource fields are mutually exclusive: you can use only one of them.
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
urlSource | 
UrlDataSource | No | No | No | File accessible via a public URL. | 
objectStorageSource | 
ObjectStorageDataSource | No | No | No | File residing in an Object Storage bucket. | 
UrlDataSource object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
url | 
string | 
Yes | No | Yes | Public URL. | 
ObjectStorageDataSource object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
bucket | 
string | 
Yes | No | No | Name of the bucket the file resides in. | 
object | 
string | 
Yes | No | Yes | Name of the object containing the file, e.g., prefix/subprefix/data.json. | 
AIAgentTool object
| Field name | Type | Required | Default value | Templating is supported | Description | 
|---|---|---|---|---|---|
mcpServer | 
MCPServer | No | No | No | MCP server. | 
MCPServer object
The useServiceAccount and token fields are mutually exclusive: you can use only one of them.
| 
 Field name  | 
 Type  | 
 Required  | 
 Default value  | 
 Templating is supported  | 
 Description  | 
| 
 
  | 
 
  | 
 Yes  | 
 No  | 
 No  | 
 MCP server URL, e.g.,   | 
| 
 
  | 
 
  | 
 Yes  | 
 No  | 
 No  | 
 Transport mechanism type for interacting with the MCP server. Available types: 
  | 
| 
 
  | 
 
  | 
 No  | 
 No  | 
 No  | 
 If set to: 
  | 
| 
 
  | 
 
  | 
 No  | 
 No  | 
 No  | 
 OAuth token to use for authentication in the MCP server.  |