FoundationModelsCall
Written by
Updated at October 14, 2025
- FoundationModelsGenerate object
- FoundationModelsGenerate.Messages object
- FoundationModelsGenerate.Message object
- FoundationModelsGenerate.ReasoningOptions object
- FoundationModelsClassify object
- FoundationModelsFewShotClassify object
- FoundationModelsFewShotClassify.Labels object
- FoundationModelsFewShotClassify.Samples object
- FoundationModelsFewShotClassify.Sample object
Integration with Yandex AI Studio.
The generate, classify, and fewShotClassify fields are mutually exclusive: you can use only one of them.
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
modelUrl |
string |
Yes | No | No | ID of the model to call. |
generate |
FoundationModelsGenerate | No | No | No | Configuring a generate action to generate a text. |
classify |
FoundationModelsClassify | No | No | No | Configuring a classify action to tune a classification. |
fewShotClassify |
FoundationModelsFewShotClassify | No | No | No | Configuring a fewShotClassify action to classify based on a prompt. |
FoundationModelsGenerate object
The json and messages fields are mutually exclusive: you can use only one of them. The jsonSchema and jsonObject fields are mutually exclusive: you can use only one of them.
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
temperature |
number |
Yes | 0.3 |
No | With a higher temperature, you get a more creative and randomized response from the model. This parameter accepts values between 0 and 1, inclusive. |
maxTokens |
integer |
Yes | 5.0 |
No | Maximum number of tokens to generate. Allows limiting the model's response if needed. |
json |
string |
No | "" |
Yes | Context for the model, as a JSON string. For more information, see the messages field description in the AI Studio documentation. |
messages |
FoundationModelsGenerate.Messages[] | No | "" |
No | Context for the model, as a list of input messages. |
reasoningOptions |
FoundationModelsGenerate.ReasoningOptions | No | No | No | Reasoning mode. For more information, see this AI Studio article. |
jsonSchema |
string |
No | No | Yes | Model's JSON-formatted response |
jsonObject |
boolean |
No | No | No | If true, the model returns a response as a JSON object. Otherwise, the response is formatted using Markdown. For more information, see this AI Studio article. |
FoundationModelsGenerate.Messages object
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
messages |
FoundationModelsGenerate.Message | Yes | No | Yes | Input messages |
FoundationModelsGenerate.Message object
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
role |
string |
Yes | No | No | Message sender ID. Values to choose from: system, assistant, and user. For more information, see TextGeneration.completion. |
text |
string |
Yes | No | Yes | Message text. For more information, see TextGeneration.completion. |
FoundationModelsGenerate.ReasoningOptions object
|
Field name |
Type |
This is a required field |
Default value |
Templating is supported |
Description |
|
|
|
Yes |
|
No |
Possible statuses of the reasoning mode:
|
FoundationModelsClassify object
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
text |
string |
Yes | No | Yes | Text description of the message |
FoundationModelsFewShotClassify object
The labelsJson and labelsArray fields are mutually exclusive: you can use only one of them. The samplesJson and samplesArray fields are mutually exclusive: you can use only one of them.
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
taskDescription |
string |
Yes | No | Yes | Text description of the task for the classifier |
text |
string |
Yes | No | Yes | Text description of the message |
labelsJson |
string |
No | No | Yes | Classes as a JSON object |
labelsArray |
FoundationModelsFewShotClassify.Labels[] | No | No | No | Classes as an array |
samplesJson |
string |
No | No | Yes | Examples of requests as a JSON object |
samplesArray |
FoundationModelsFewShotClassify.Samples[] | No | No | No | Examples of requests as an array |
FoundationModelsFewShotClassify.Labels object
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
labels |
string |
Yes | No | Yes | Classes |
FoundationModelsFewShotClassify.Samples object
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
samples |
FoundationModelsFewShotClassify.Sample | Yes | No | No | Request examples |
FoundationModelsFewShotClassify.Sample object
| Field name | Type | Required | Default value | Templating is supported | Description |
|---|---|---|---|---|---|
text |
string |
Yes | No | Yes | Text description of the message |
label |
string |
Yes | No | Yes | Class |