Other types

Settings typesSettings types

class yandexcloudmlsdk.models.completions.config.ReasoningModeclass yandex_cloud_ml_sdk._models.completions.config.ReasoningMode

Enumeration for reasoning modes.

This class defines the various modes of reasoning that can be used in the model’s configurations.

REASONING_MODE_UNSPECIFIED = 0

indicates that the reasoning mode is unspecified

DISABLED = 1

indicates that reasoning is disabled

ENABLED_HIDDEN = 2

indicates that reasoning is enabled but hidden

class yandexcloudmlsdk.chat.completions.config.ChatReasoningModeclass yandex_cloud_ml_sdk._chat.completions.config.ChatReasoningMode

Enumeration for reasoning modes in chat completions.

This enumeration defines the various levels of reasoning effort that can be applied during chat completion generation. Higher reasoning modes allow the model to perform more thorough internal reasoning before responding, potentially improving response quality.

LOW = 'low'

Low reasoning effort mode

MEDIUM = 'medium'

Medium reasoning effort mode

HIGH = 'high'

High reasoning effort mode

__new__(value)

encode(encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding

The encoding in which to encode the string.

errors

The error handling scheme to use for encoding errors. The default is ‘strict’ meaning that encoding errors raise a UnicodeEncodeError. Other possible values are ‘ignore’, ‘replace’ and ‘xmlcharrefreplace’ as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

replace(old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

countMaximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

split(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sepThe separator used to split the string.When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.maxsplitMaximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

rsplit(sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sepThe separator used to split the string.When set to None (the default value), will split on any whitespace character (including n r t f and spaces) and will discard empty strings from the result.maxsplitMaximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

join(iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: ‘.’.join([‘ab’, ‘pq’, ‘rs’]) -> ‘ab.pq.rs’

capitalize()

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold()

Return a version of the string suitable for caseless comparisons.

title()

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

center(width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count(sub[, start[, end]]) → int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

expandtabs(tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

partition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

index(sub[, start[, end]]) → int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

ljust(width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower()

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

rfind(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex(sub[, start[, end]]) → int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust(width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rstrip(chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

rpartition(sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

splitlines(keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

strip(chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase()

Convert uppercase characters to lowercase and lowercase characters to uppercase.

translate(table, /)

Replace each character in the string using the given translation table.

tableTranslation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via __getitem__, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper()

Return a copy of the string converted to uppercase.

startswith(prefix[, start[, end]]) → bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

endswith(suffix[, start[, end]]) → bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

removeprefix(prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix(suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

isascii()

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

islower()

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isupper()

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

istitle()

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isspace()

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

isdecimal()

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit()

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isnumeric()

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isalpha()

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isalnum()

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isidentifier()

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as “def” or “class”.

isprintable()

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

zfill(width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

format(*args, **kwargs) → str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping) → str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

static maketrans()

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

Generic typesGeneric types

class yandexcloudmlsdk.types.model.ModelTypeTclass yandex_cloud_ml_sdk._types.model.ModelTypeT

class yandexcloudmlsdk.types.model.ConfigTypeTclass yandex_cloud_ml_sdk._types.model.ConfigTypeT

class yandexcloudmlsdk.types.batch.domain.BatchSubdomainTypeTclass yandex_cloud_ml_sdk._types.batch.domain.BatchSubdomainTypeT

class yandexcloudmlsdk.tools.toolcall.ToolCallTypeTclass yandex_cloud_ml_sdk._tools.tool_call.ToolCallTypeT

class yandexcloudmlsdk.tools.function.FunctionToolsTypeTclass yandex_cloud_ml_sdk._tools.function.FunctionToolsTypeT

class yandexcloudmlsdk.tools.functioncall.FunctionCallTypeTclass yandex_cloud_ml_sdk._tools.function_call.FunctionCallTypeT

class yandexcloudmlsdk.datasets.draft.DatasetDraftTclass yandex_cloud_ml_sdk._datasets.draft.DatasetDraftT

class yandexcloudmlsdk.tuning.tuningtask.TuningResultTypeTcoclass yandex_cloud_ml_sdk._tuning.tuning_task.TuningResultTypeT_co

class yandexcloudmlsdk.types.operation.ResultTypeTcoclass yandex_cloud_ml_sdk._types.operation.ResultTypeT_co

class yandexcloudmlsdk.searchapi.generative.generative.GenerativeSearchTypeTclass yandex_cloud_ml_sdk._search_api.generative.generative.GenerativeSearchTypeT

class yandexcloudmlsdk.runs.result.StatusTypeTclass yandex_cloud_ml_sdk._runs.result.StatusTypeT

class yandexcloudmlsdk.runs.result.MessageTypeTclass yandex_cloud_ml_sdk._runs.result.MessageTypeT

class yandexcloudmlsdk.types.operation.AnyResultTypeTcoclass yandex_cloud_ml_sdk._types.operation.AnyResultTypeT_co

class yandexcloudmlsdk.types.operation.OperationStatusTypeTclass yandex_cloud_ml_sdk._types.operation.OperationStatusTypeT

class yandexcloudmlsdk.searchapi.web.web.WebSearchTypeTclass yandex_cloud_ml_sdk._search_api.web.web.WebSearchTypeT

class yandexcloudmlsdk.searchapi.image.image.ImageSearchTypeTclass yandex_cloud_ml_sdk._search_api.image.image.ImageSearchTypeT

class yandexcloudmlsdk.searchapi.byimage.byimage.ByImageSearchTypeTclass yandex_cloud_ml_sdk._search_api.by_image.by_image.ByImageSearchTypeT

class yandexcloudmlsdk.searchapi.types.XMLSearchDocumentTypeTclass yandex_cloud_ml_sdk._search_api.types.XMLSearchDocumentTypeT

Miscellaneous typesMiscellaneous types

class yandexcloudmlsdk.types.misc.Undefinedclass yandex_cloud_ml_sdk._types.misc.Undefined

Class for making possible to differ None and not-passed default value.

Sentinel until PEP 0661.

class yandexcloudmlsdk.types.misc.UndefinedOrclass yandex_cloud_ml_sdk._types.misc.UndefinedOr

class yandexcloudmlsdk.types.misc.PathLikeclass yandex_cloud_ml_sdk._types.misc.PathLike

yandex_cloud_ml_sdk._types.misc.UNDEFINED = Undefined

Default, non-passed value

yandex_cloud_ml_sdk._types.schemas.LITERAL_RESPONSE_FORMATS = ('json',)

Available response formats

yandex_cloud_ml_sdk._types.schemas.StrResponseType

Type for string response formats

Alias of Literal['json']

yandex_cloud_ml_sdk._types.schemas.JsonVal

Recurrent json object

Alias of Union[None, bool, str, float, int, JsonArray, JsonObject]

yandex_cloud_ml_sdk._types.schemas.JsonArray

Json array

Alias of list[Union[None, bool, str, float, int, JsonArray, JsonObject]]

yandex_cloud_ml_sdk._types.schemas.JsonObject

Json object

Alias of dict[str, Union[None, bool, str, float, int, JsonArray, JsonObject]]

yandex_cloud_ml_sdk._types.schemas.JsonSchemaType

Type for json schema

Alias of dict[str, Union[None, bool, str, float, int, JsonArray, JsonObject]]

yandex_cloud_ml_sdk._types.schemas.QueryType

Type alias for model arguments

Alias of dict[str, Union[None, bool, str, float, int, JsonArray, JsonObject]]

typeddict yandex_cloud_ml_sdk._types.schemas.JsonSchemaResponseType

Bases: TypedDict

Dict with json schema response settings

Required Keys

json_schema (dict[str, Union[None, bool, str, float, int, TypeAliasForwardRef, dict[str, Union[None, bool, str, float, int, TypeAliasForwardRef, JsonObject]]]]) – Field with json schema which describes response format strict (bool) name (str)

yandex_cloud_ml_sdk._types.schemas.ResponseType

Types availailable for response format

Alias of Union[Literal['json'], JsonSchemaResponseType, type]

yandex_cloud_ml_sdk._types.schemas.ParametersType

Types available for function call parameters

Alias of Union[dict[str, Union[None, bool, str, float, int, JsonArray, JsonObject]], type]

typeddict yandex_cloud_ml_sdk._types.schemas.JsonObjectProtoFormat

Bases: TypedDict

typing.TypedDict.

Required Keys

json_object (bool)

typeddict yandex_cloud_ml_sdk._types.schemas.JsonSchemaProtoFormat

Bases: TypedDict

typing.TypedDict.

Required Keys

json_schema (dict[str, Union[None, bool, str, float, int, TypeAliasForwardRef, dict[str, Union[None, bool, str, float, int, TypeAliasForwardRef, JsonObject]]]]) – Field with json schema which describes response format

typeddict yandex_cloud_ml_sdk._types.schemas.EmptyProtoFormat

Bases: TypedDict

typing.TypedDict.

typeddict yandex_cloud_ml_sdk._types.schemas.JsonSchemaResponseFormat

Bases: TypedDict

typing.TypedDict.

Required Keys

schema (dict[str, Union[None, bool, str, float, int, TypeAliasForwardRef, dict[str, Union[None, bool, str, float, int, TypeAliasForwardRef, JsonObject]]]]) strict (bool) name (str)

typeddict yandex_cloud_ml_sdk._types.schemas.JsonSchemaParameterType

Bases: TypedDict

typing.TypedDict.

Required Keys

type (Literal['json_object', 'json_schema']) json_schema (JsonSchemaResponseFormat) – Field with json schema which describes response format

yandex_cloud_ml_sdk._types.schemas.make_response_format_kwargs(response_format)

Here we are transforming 1) http_schema <- schema_from_response_format(response_format) 2) grpc_schema <- http_schema

Parameters	response_format (Literal['json'] | ~yandex_cloud_ml_sdk._types.schemas.JsonSchemaResponseType | type | None)
Return type	JsonObjectProtoFormat | JsonSchemaProtoFormat | EmptyProtoFormat

class yandexcloudmlsdk.tools.toolcalllist.HttpToolCallListclass yandex_cloud_ml_sdk._tools.tool_call_list.HttpToolCallList

class yandexcloudmlsdk.types.enum.UnknownEnumValueclass yandex_cloud_ml_sdk._types.enum.UnknownEnumValue

class yandexcloudmlsdk.searchapi.utils.NestedDictclass yandex_cloud_ml_sdk._search_api.utils.NestedDict

Completions-related typesCompletions-related types

class yandexcloudmlsdk.chat.completions.config.ChatReasoningModeTypeclass yandex_cloud_ml_sdk._chat.completions.config.ChatReasoningModeType

yandex_cloud_ml_sdk._chat.completions.config.ChatReasoningModeType

alias of Literal[‘low’, ‘medium’, ‘high’] | Literal[‘LOW’, ‘MEDIUM’, ‘HIGH’] | ChatReasoningMode

class yandexcloudmlsdk.chat.textembeddings.config.EncodingFormatTypeclass yandex_cloud_ml_sdk._chat.text_embeddings.config.EncodingFormatType

yandex_cloud_ml_sdk._chat.text_embeddings.config.EncodingFormatType

alias of Literal[‘float’]

class yandexcloudmlsdk.chat.completions.config.QueryTypeclass yandex_cloud_ml_sdk._chat.completions.config.QueryType

class yandexcloudmlsdk.models.completions.config.CompletionToolclass yandex_cloud_ml_sdk._models.completions.config.CompletionTool

yandex_cloud_ml_sdk._models.completions.config.CompletionTool: TypeAlias = <class 'yandex_cloud_ml_sdk._tools.tool.FunctionTool'>

type alias for completion tools

Parameters	name (str) description (str | None) parameters (dict[str, None | bool | str | float | int | TypeAliasForwardRef('yandex_cloud_ml_sdk._types.schemas.JsonArray') | dict[str, None | bool | str | float | int | TypeAliasForwardRef('yandex_cloud_ml_sdk._types.schemas.JsonArray') | JsonObject]]) strict (bool | None)
Return type	None

class yandexcloudmlsdk.types.tools.toolchoice.ToolChoiceTypeclass yandex_cloud_ml_sdk._types.tools.tool_choice.ToolChoiceType

yandex_cloud_ml_sdk._types.tools.tool_choice.ToolChoiceType

alias of Literal[‘none’, ‘None’, ‘NONE’, ‘auto’, ‘Auto’, ‘AUTO’, ‘required’, ‘Required’, ‘REQUIRED’] | FunctionDictType | FunctionTool