Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Foundation Models
    • Overview
    • API authentication
        • Overview
          • Overview
          • Tune
          • List
          • Describe
          • Cancel
          • GetMetricsUrl
          • GetOptions
          • ListErrors
          • CreateDraft
          • UpdateDraft
          • DeleteDraft
          • TuneDraft
  • Yandex Cloud ML SDK
  • Compatibility with OpenAI
  • Access management
  • Pricing policy
  • Public materials
  • Release notes

In this article:

  • gRPC request
  • GetOptionsRequest
  • GetOptionsResponse
  • WeightedDataset
  • TextToTextCompletionTuningParams
  • TuningTypeLora
  • TuningTypePromptTune
  • Scheduler
  • SchedulerLinear
  • SchedulerConstant
  • SchedulerCosine
  • Optimizer
  • OptimizerAdamw
  • TextClassificationMultilabelParams
  • Scheduler
  • Optimizer
  • TextClassificationMulticlassParams
  • Scheduler
  • Optimizer
  • TextEmbeddingPairParams
  • Scheduler
  • Optimizer
  • TextEmbeddingTripletParams
  • Scheduler
  • Optimizer
  1. API references
  2. Tuning API
  3. gRPC
  4. Tuning
  5. GetOptions

Foundation Models Tuning Service API, gRPC: TuningService.GetOptions

Written by
Yandex Cloud
Improved by
Tania L.
Updated at February 21, 2025
  • gRPC request
  • GetOptionsRequest
  • GetOptionsResponse
  • WeightedDataset
  • TextToTextCompletionTuningParams
  • TuningTypeLora
  • TuningTypePromptTune
  • Scheduler
  • SchedulerLinear
  • SchedulerConstant
  • SchedulerCosine
  • Optimizer
  • OptimizerAdamw
  • TextClassificationMultilabelParams
  • Scheduler
  • Optimizer
  • TextClassificationMulticlassParams
  • Scheduler
  • Optimizer
  • TextEmbeddingPairParams
  • Scheduler
  • Optimizer
  • TextEmbeddingTripletParams
  • Scheduler
  • Optimizer

gRPC requestgRPC request

rpc GetOptions (GetOptionsRequest) returns (GetOptionsResponse)

GetOptionsRequestGetOptionsRequest

{
  "task_id": "string"
}

Field

Description

task_id

string

Required field.

GetOptionsResponseGetOptionsResponse

{
  "task_id": "string",
  "base_model_uri": "string",
  "train_datasets": [
    {
      "dataset_id": "string",
      "weight": "double"
    }
  ],
  "validation_datasets": [
    {
      "dataset_id": "string",
      "weight": "double"
    }
  ],
  // Includes only one of the fields `text_to_text_completion`, `text_classification_multilabel`, `text_classification_multiclass`, `text_embedding_pair_params`, `text_embedding_triplet_params`
  "text_to_text_completion": {
    "seed": "int64",
    "lr": "double",
    "n_samples": "int64",
    "additional_arguments": "string",
    // Includes only one of the fields `lora`, `prompt_tune`
    "lora": {
      "rank": "int64",
      "alpha": "double",
      "initialization": "string",
      "type": "string"
    },
    "prompt_tune": {
      "virtual_tokens": "int64"
    },
    // end of the list of possible fields
    "scheduler": {
      // Includes only one of the fields `linear`, `constant`, `cosine`
      "linear": {
        "min_lr": "double"
      },
      "constant": "SchedulerConstant",
      "cosine": {
        "min_lr": "double"
      },
      // end of the list of possible fields
      "warmup_ratio": "double"
    },
    "optimizer": {
      // Includes only one of the fields `adamw`
      "adamw": {
        "beta1": "double",
        "beta2": "double",
        "eps": "double",
        "weight_decay": "double"
      }
      // end of the list of possible fields
    }
  },
  "text_classification_multilabel": {
    "seed": "int64",
    "lr": "double",
    "n_samples": "int64",
    "additional_arguments": "string",
    // Includes only one of the fields `lora`, `prompt_tune`
    "lora": {
      "rank": "int64",
      "alpha": "double",
      "initialization": "string",
      "type": "string"
    },
    "prompt_tune": {
      "virtual_tokens": "int64"
    },
    // end of the list of possible fields
    "scheduler": {
      // Includes only one of the fields `linear`, `constant`, `cosine`
      "linear": {
        "min_lr": "double"
      },
      "constant": "SchedulerConstant",
      "cosine": {
        "min_lr": "double"
      },
      // end of the list of possible fields
      "warmup_ratio": "double"
    },
    "optimizer": {
      // Includes only one of the fields `adamw`
      "adamw": {
        "beta1": "double",
        "beta2": "double",
        "eps": "double",
        "weight_decay": "double"
      }
      // end of the list of possible fields
    }
  },
  "text_classification_multiclass": {
    "seed": "int64",
    "lr": "double",
    "n_samples": "int64",
    "additional_arguments": "string",
    // Includes only one of the fields `lora`, `prompt_tune`
    "lora": {
      "rank": "int64",
      "alpha": "double",
      "initialization": "string",
      "type": "string"
    },
    "prompt_tune": {
      "virtual_tokens": "int64"
    },
    // end of the list of possible fields
    "scheduler": {
      // Includes only one of the fields `linear`, `constant`, `cosine`
      "linear": {
        "min_lr": "double"
      },
      "constant": "SchedulerConstant",
      "cosine": {
        "min_lr": "double"
      },
      // end of the list of possible fields
      "warmup_ratio": "double"
    },
    "optimizer": {
      // Includes only one of the fields `adamw`
      "adamw": {
        "beta1": "double",
        "beta2": "double",
        "eps": "double",
        "weight_decay": "double"
      }
      // end of the list of possible fields
    }
  },
  "text_embedding_pair_params": {
    "seed": "int64",
    "lr": "double",
    "n_samples": "int64",
    "additional_arguments": "string",
    "embedding_dims": [
      "int64"
    ],
    // Includes only one of the fields `lora`, `prompt_tune`
    "lora": {
      "rank": "int64",
      "alpha": "double",
      "initialization": "string",
      "type": "string"
    },
    "prompt_tune": {
      "virtual_tokens": "int64"
    },
    // end of the list of possible fields
    "scheduler": {
      // Includes only one of the fields `linear`, `constant`, `cosine`
      "linear": {
        "min_lr": "double"
      },
      "constant": "SchedulerConstant",
      "cosine": {
        "min_lr": "double"
      },
      // end of the list of possible fields
      // Includes only one of the fields `warmup_ratio`
      "warmup_ratio": "double"
      // end of the list of possible fields
    },
    "optimizer": {
      // Includes only one of the fields `adamw`
      "adamw": {
        "beta1": "double",
        "beta2": "double",
        "eps": "double",
        "weight_decay": "double"
      }
      // end of the list of possible fields
    }
  },
  "text_embedding_triplet_params": {
    "seed": "int64",
    "lr": "double",
    "n_samples": "int64",
    "additional_arguments": "string",
    "embedding_dims": [
      "int64"
    ],
    // Includes only one of the fields `lora`, `prompt_tune`
    "lora": {
      "rank": "int64",
      "alpha": "double",
      "initialization": "string",
      "type": "string"
    },
    "prompt_tune": {
      "virtual_tokens": "int64"
    },
    // end of the list of possible fields
    "scheduler": {
      // Includes only one of the fields `linear`, `constant`, `cosine`
      "linear": {
        "min_lr": "double"
      },
      "constant": "SchedulerConstant",
      "cosine": {
        "min_lr": "double"
      },
      // end of the list of possible fields
      // Includes only one of the fields `warmup_ratio`
      "warmup_ratio": "double"
      // end of the list of possible fields
    },
    "optimizer": {
      // Includes only one of the fields `adamw`
      "adamw": {
        "beta1": "double",
        "beta2": "double",
        "eps": "double",
        "weight_decay": "double"
      }
      // end of the list of possible fields
    }
  }
  // end of the list of possible fields
}

Field

Description

task_id

string

base_model_uri

string

train_datasets[]

WeightedDataset

validation_datasets[]

WeightedDataset

text_to_text_completion

TextToTextCompletionTuningParams

Includes only one of the fields text_to_text_completion, text_classification_multilabel, text_classification_multiclass, text_embedding_pair_params, text_embedding_triplet_params.

text_classification_multilabel

TextClassificationMultilabelParams

Includes only one of the fields text_to_text_completion, text_classification_multilabel, text_classification_multiclass, text_embedding_pair_params, text_embedding_triplet_params.

text_classification_multiclass

TextClassificationMulticlassParams

Includes only one of the fields text_to_text_completion, text_classification_multilabel, text_classification_multiclass, text_embedding_pair_params, text_embedding_triplet_params.

text_embedding_pair_params

TextEmbeddingPairParams

Includes only one of the fields text_to_text_completion, text_classification_multilabel, text_classification_multiclass, text_embedding_pair_params, text_embedding_triplet_params.

text_embedding_triplet_params

TextEmbeddingTripletParams

Includes only one of the fields text_to_text_completion, text_classification_multilabel, text_classification_multiclass, text_embedding_pair_params, text_embedding_triplet_params.

WeightedDatasetWeightedDataset

Field

Description

dataset_id

string

Required field.

weight

double

TextToTextCompletionTuningParamsTextToTextCompletionTuningParams

Field

Description

seed

int64

lr

double

n_samples

int64

additional_arguments

string

lora

TuningTypeLora

Includes only one of the fields lora, prompt_tune.

prompt_tune

TuningTypePromptTune

Includes only one of the fields lora, prompt_tune.

scheduler

Scheduler

optimizer

Optimizer

TuningTypeLoraTuningTypeLora

Field

Description

rank

int64

alpha

double

Integer value

initialization

string

type

string

TuningTypePromptTuneTuningTypePromptTune

Field

Description

virtual_tokens

int64

SchedulerScheduler

Field

Description

linear

SchedulerLinear

Includes only one of the fields linear, constant, cosine.

constant

SchedulerConstant

Includes only one of the fields linear, constant, cosine.

cosine

SchedulerCosine

Includes only one of the fields linear, constant, cosine.

warmup_ratio

double

SchedulerLinearSchedulerLinear

Field

Description

min_lr

double

SchedulerConstantSchedulerConstant

Field

Description

Empty

SchedulerCosineSchedulerCosine

Field

Description

min_lr

double

OptimizerOptimizer

Field

Description

adamw

OptimizerAdamw

Includes only one of the fields adamw.

OptimizerAdamwOptimizerAdamw

Field

Description

beta1

double

beta2

double

eps

double

weight_decay

double

TextClassificationMultilabelParamsTextClassificationMultilabelParams

Field

Description

seed

int64

lr

double

n_samples

int64

additional_arguments

string

lora

TuningTypeLora

Includes only one of the fields lora, prompt_tune.

prompt_tune

TuningTypePromptTune

Includes only one of the fields lora, prompt_tune.

scheduler

Scheduler

optimizer

Optimizer

SchedulerScheduler

Field

Description

linear

SchedulerLinear

Includes only one of the fields linear, constant, cosine.

constant

SchedulerConstant

Includes only one of the fields linear, constant, cosine.

cosine

SchedulerCosine

Includes only one of the fields linear, constant, cosine.

warmup_ratio

double

OptimizerOptimizer

Field

Description

adamw

OptimizerAdamw

Includes only one of the fields adamw.

TextClassificationMulticlassParamsTextClassificationMulticlassParams

Field

Description

seed

int64

lr

double

n_samples

int64

additional_arguments

string

lora

TuningTypeLora

Includes only one of the fields lora, prompt_tune.

prompt_tune

TuningTypePromptTune

Includes only one of the fields lora, prompt_tune.

scheduler

Scheduler

optimizer

Optimizer

SchedulerScheduler

Field

Description

linear

SchedulerLinear

Includes only one of the fields linear, constant, cosine.

constant

SchedulerConstant

Includes only one of the fields linear, constant, cosine.

cosine

SchedulerCosine

Includes only one of the fields linear, constant, cosine.

warmup_ratio

double

OptimizerOptimizer

Field

Description

adamw

OptimizerAdamw

Includes only one of the fields adamw.

TextEmbeddingPairParamsTextEmbeddingPairParams

Field

Description

seed

int64

lr

double

n_samples

int64

additional_arguments

string

embedding_dims[]

int64

lora

TuningTypeLora

Includes only one of the fields lora, prompt_tune.

prompt_tune

TuningTypePromptTune

Includes only one of the fields lora, prompt_tune.

scheduler

Scheduler

optimizer

Optimizer

SchedulerScheduler

Field

Description

linear

SchedulerLinear

Includes only one of the fields linear, constant, cosine.

constant

SchedulerConstant

Includes only one of the fields linear, constant, cosine.

cosine

SchedulerCosine

Includes only one of the fields linear, constant, cosine.

warmup_ratio

double

Includes only one of the fields warmup_ratio.

OptimizerOptimizer

Field

Description

adamw

OptimizerAdamw

Includes only one of the fields adamw.

TextEmbeddingTripletParamsTextEmbeddingTripletParams

Field

Description

seed

int64

lr

double

n_samples

int64

additional_arguments

string

embedding_dims[]

int64

lora

TuningTypeLora

Includes only one of the fields lora, prompt_tune.

prompt_tune

TuningTypePromptTune

Includes only one of the fields lora, prompt_tune.

scheduler

Scheduler

optimizer

Optimizer

SchedulerScheduler

Field

Description

linear

SchedulerLinear

Includes only one of the fields linear, constant, cosine.

constant

SchedulerConstant

Includes only one of the fields linear, constant, cosine.

cosine

SchedulerCosine

Includes only one of the fields linear, constant, cosine.

warmup_ratio

double

Includes only one of the fields warmup_ratio.

OptimizerOptimizer

Field

Description

adamw

OptimizerAdamw

Includes only one of the fields adamw.

Was the article helpful?

Previous
GetMetricsUrl
Next
ListErrors
Yandex project
© 2025 Yandex.Cloud LLC