FoundationModelsCall

Integration with Yandex Cloud AI Studio.

The generate, classify, fewShotClassify, and vision fields are mutually exclusive: you can use only one of them.

Field name	Type	Required	Default value	Templating is supported	Description
modelUrl	string	Yes	None	None	ID of the model to call.
generate	FoundationModelsGenerate	None	None	None	Configuring a generate action to generate a text.
classify	FoundationModelsClassify	None	None	None	Configuring a classify action to tune a classification.
fewShotClassify	FoundationModelsFewShotClassify	None	None	None	Configuring a fewShotClassify action to classify based on a prompt.
vision	FoundationModelsVision	None	None	None	Configuring a vision action to work with images.
dataLoggingEnabled	boolean	None	true	None	Enabling request logging. If false, logging is disabled. For more information, see this AI Studio guide.

FoundationModelsGenerate objectFoundationModelsGenerate 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	None	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	None	Maximum number of tokens to generate. Allows limiting the model's response if needed.
json	string	None	""	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[]	None	[]	None	Context for the model, as a list of input messages.
reasoningOptions	FoundationModelsGenerate.ReasoningOptions	None	None	None	Reasoning mode. For more information, see this AI Studio guide.
jsonSchema	string	None	None	Yes	Model's JSON-formatted response
jsonObject	boolean	None	None	None	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 guide.

FoundationModelsGenerate.Messages objectFoundationModelsGenerate.Messages object

Field name	Type	Required	Default value	Templating is supported	Description
messages	FoundationModelsGenerate.Message	Yes	None	Yes	Input messages

FoundationModelsGenerate.Message objectFoundationModelsGenerate.Message object

Field name	Type	Required	Default value	Templating is supported	Description
role	string	Yes	None	None	Message sender ID. The available values are system, assistant, and user. For more information, see TextGeneration.completion.
text	string	Yes	None	Yes	Message text. For more information, see TextGeneration.completion.

FoundationModelsGenerate.ReasoningOptions objectFoundationModelsGenerate.ReasoningOptions object

Field name	Type	This is a required field	Default value	Templating is supported	Description
mode	string	Yes	REASONING_MODE_UNSPECIFIED	None	Possible statuses of the reasoning mode: REASONING_MODE_UNSPECIFIED: Not specified. DISABLED: Disabled. ENABLED_HIDDEN: Enabled.

FoundationModelsClassify objectFoundationModelsClassify object

Field name	Type	Required	Default value	Templating is supported	Description
text	string	Yes	None	Yes	Text description of the message

FoundationModelsFewShotClassify objectFoundationModelsFewShotClassify 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	None	Yes	Text description of the task for the classifier
text	string	Yes	None	Yes	Text description of the message
labelsJson	string	None	None	Yes	Classes as a JSON object
labelsArray	FoundationModelsFewShotClassify.Labels[]	None	None	None	Classes as an array
samplesJson	string	None	None	Yes	Examples of requests as a JSON object
samplesArray	FoundationModelsFewShotClassify.Samples[]	None	None	None	Examples of requests as an array

FoundationModelsFewShotClassify.Labels objectFoundationModelsFewShotClassify.Labels object

Field name	Type	Required	Default value	Templating is supported	Description
labels	string	Yes	None	Yes	Classes

FoundationModelsFewShotClassify.Samples objectFoundationModelsFewShotClassify.Samples object

Field name	Type	Required	Default value	Templating is supported	Description
samples	FoundationModelsFewShotClassify.Sample	Yes	None	None	Request examples

FoundationModelsFewShotClassify.Sample objectFoundationModelsFewShotClassify.Sample object

Field name	Type	Required	Default value	Templating is supported	Description
text	string	Yes	None	Yes	Text description of the message
label	string	Yes	None	Yes	Class

FoundationModelsVision objectFoundationModelsVision object

The json and messages 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	None	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	None	Maximum number of tokens to generate. Allows limiting the model's response if needed.
json	string	None	""	Yes	Context for the model, as a JSON string. For more information, see the messages field description in the AI Studio documentation.
messages	FoundationModelsVision.Messages[]	None	[]	None	Context for the model, as a list of input messages.

FoundationModelsVision.Messages objectFoundationModelsVision.Messages object

Field name	Type	Required	Default value	Templating is supported	Description
messages	FoundationModelsVision.Message	Yes	None	Yes	Input messages

FoundationModelsVision.Message objectFoundationModelsVision.Message object

Field name	Type	Required	Default value	Templating is supported	Description
role	string	Yes	None	None	Message sender ID. The available values are system, assistant, and user. For more information, see TextGeneration.completion. If the images field is not empty, specify role: user.
text	string	Yes	None	Yes	Message text. For more information, see TextGeneration.completion.
images	FoundationModelsVision.Image	None	None	None	Images to add to the message.

FoundationModelsVision.ImageFoundationModelsVision.Image

The base64 and file fields are mutually exclusive: you can use only one of them.

Field name	Type	Required	Default value	Templating is supported	Description
base64	string	None	None	Yes	Image in Base64 format
file	FoundationModelsVision.File	None	None	None	Image from the provided source

FoundationModelsVision.FileFoundationModelsVision.File

The url and objectStorage fields are mutually exclusive: you can use only one of them.

Field name	Type	Required	Default value	Templating is supported	Description
url	string	None	None	Yes	Publicly accessible image URL
objectStorage	FoundationModelsVision.ObjectStorage	None	None	None	Image from an Object Storage bucket

FoundationModelsVision.ObjectStorageFoundationModelsVision.ObjectStorage

Field name	Type	Required	Default value	Templating is supported	Description
bucket	string	Yes	None	None	Name of the Object Storage bucket containing the image
object	string	Yes	None	Yes	Name of the image object, e.g., prefix/subprefix/image.png