Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Истории успеха
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • ИИ для бизнеса
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Калькулятор цен
    • Тарифы
    • Промоакции и free tier
    • Правила тарификации
  • Истории успеха
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex AI Studio
  • Начало работы с Model Gallery
    • О сервисе Yandex AI Studio
    • Yandex Workflows
    • Квоты и лимиты
    • Термины и определения
  • Переход с AI Assistant API на Responses API
  • Совместимость с OpenAI
    • О Yandex Cloud ML SDK
      • Overview
        • Overview
        • Models domain
        • Assistants domain
        • Tools domain
        • Files domain
        • Threads domain
        • Runs domain
        • Search indexes domain
        • Search API domain
        • Datasets domain
        • Tuning domain
        • Batch domain
        • Chat domain
      • Authentication
      • Request retries
  • Управление доступом
  • Правила тарификации
  • Аудитные логи Audit Trails
  • Публичные материалы
  • История изменений
  1. Yandex Cloud ML SDK
  2. Справочник SDK (англ.)
  3. SDK
  4. Overview

SDK

Статья создана
Yandex Cloud
Обновлена 7 ноября 2025 г.

class yandexcloudmlsdk.YCloudMLclass yandex_cloud_ml_sdk.YCloudML

The main class that needs to be instantiated to work with SDK.

tools: Tools

Domain for creating various tools for assistants and function calling

models: Models

Domain for working with models (inference and tuning)

files: Files

Domain for working with files (a part of the Asssistants API)

threads: Threads

Domain for working with threads (a part of the Assistants API)

assistants: Assistants

Domain for working with assistants (a part of the Assistants API)

runs: Runs

Domain for working with assistants’ runs (a part of the Assistants API)

search_api: SearchAPIDomain

Domain for working with Search API

search_indexes: SearchIndexes

Domain for working with search indexes (a part of the Assistants API)

datasets: Datasets

Domain for working with datasets

tuning: Tuning

Domain for working with tuning

batch: Batch

Domain for working with batch tasks

chat: Chat

Domain for working with Yandex Cloud OpenAI Compatible API_BaseSDK_URL.

__init__(*, folder_id=Undefined, endpoint=Undefined, auth=Undefined, retry_policy=Undefined, yc_profile=Undefined, service_map=Undefined, interceptors=Undefined, enable_server_data_logging=Undefined, verify=Undefined)

Construct a new asynchronous sdk instance.

Parameters

  • folder_id (str) – Yandex Cloud folder identifier which will be billed for models usage. In case of default Undefined value, the parameter will be taken from the environment variable YC_FOLDER_ID.
  • endpoint (str) – domain:port pair for Yandex Cloud API or any other grpc compatible target. In case of None passed it turns off service endpoint discovery mechanism and requires service_map to be passed.
  • auth (str | BaseAuth | Undefined) – string with API Key, IAM token or one of yandex_cloud_ml_sdk.auth objects; in case of default Undefined value, the token will be taken from one of the environment variables: YC_OAUTH_TOKEN, YC_TOKEN, YC_IAM_TOKEN, or YC_API_KEY.
  • service_map (Dict[str, str]) – a way to redefine endpoints for one or more cloud subservices with a format of dict {"service_name": "service_address"}.
  • enable_server_data_logging (bool | Undefined) – when passed bool, we will add x-data-logging-enabled: to all of requests, which will enable or disable logging of user data on server side. It will do something only on those parts of backends which supports this option.
  • verify (bool | pathlib.Path | str | os.PathLike) – SSL certificates (a.k.a CA bundle) used to verify the identity of requested hosts. Either True (default CA bundle), a path to an SSL certificate file, or False (which will disable verification).
  • retry_policy (RetryPolicy | Undefined)
  • yc_profile (str | Undefined)
  • interceptors (Sequence[ClientInterceptor] | Undefined)

setup_default_logging(log_level='INFO', log_format='[%(levelname)1.1s %(asctime)s %(name)s:%(lineno)d] %(message)s', date_format='%Y-%m-%d %H:%M:%S')

Sets up the default logging configuration.

Read more about log_levels, log_format, and date_format in Python documentation (logging).

Parameters

  • log_level (Literal['CRITICAL', 'FATAL', 'ERROR', 'WARN', 'WARNING', 'INFO', 'DEBUG', 'TRACE'] | ~typing.Literal['critical', 'fatal', 'error', 'warn', 'warning', 'info', 'debug', 'TRACE'] | int) – The logging level to set.
  • log_format (str) – The format of the log messages.
  • date_format (str) – The format for timestamps in log messages.

Returns

The instance of the SDK with logging configured.

Return type

Self

  • Models domain
    • Models
      • Models.completions
      • Models.text_embeddings
      • Models.text_classifiers
      • Models.image_generation
  • Assistants domain
    • Assistants
      • Assistants.create()
      • Assistants.get()
      • Assistants.list()
    • Assistant
      • Assistant.update()
      • Assistant.delete()
      • Assistant.list_versions()
      • Assistant.run()
      • Assistant.run_stream()
      • Assistant.max_prompt_tokens
      • Assistant.name
      • Assistant.description
      • Assistant.created_by
      • Assistant.created_at
      • Assistant.updated_by
      • Assistant.updated_at
      • Assistant.expires_at
      • Assistant.labels
      • Assistant.expiration_config
      • Assistant.model
      • Assistant.instruction
      • Assistant.prompt_truncation_options
      • Assistant.tools
      • Assistant.response_format
      • Assistant.id
  • Tools domain
    • Tools
      • Tools.function
      • Tools.generative_search()
      • Tools.rephraser
      • Tools.search_index()
    • Types
      • ToolCall
        • ToolCall.id
        • ToolCall.function
      • FunctionCall
        • FunctionCall.name
        • FunctionCall.arguments
  • Files domain
    • Files
      • Files.upload_bytes()
      • Files.upload()
      • Files.get()
      • Files.list()
    • File
      • File.get_url()
      • File.update()
      • File.delete()
      • File.download_as_bytes()
      • File.name
      • File.description
      • File.mime_type
      • File.created_by
      • File.created_at
      • File.updated_by
      • File.updated_at
      • File.expires_at
      • File.labels
      • File.expiration_config
      • File.id
  • Threads domain
    • Threads
      • Threads.create()
      • Threads.get()
      • Threads.list()
    • Thread
      • Thread.update()
      • Thread.delete()
      • Thread.write()
      • Thread.read()
      • Thread.name
      • Thread.description
      • Thread.created_by
      • Thread.created_at
      • Thread.updated_by
      • Thread.updated_at
      • Thread.expires_at
      • Thread.labels
      • Thread.expiration_config
      • Thread.id
  • Runs domain
    • Runs
      • Runs.get()
      • Runs.get_last_by_thread()
      • Runs.list()
    • Run
      • Run.listen()
      • Run.submit_tool_results()
      • Run.cancel()
      • Run.custom_max_prompt_tokens
      • Run.get_result()
      • Run.get_status()
      • Run.wait()
      • Run.id
      • Run.assistant_id
      • Run.thread_id
      • Run.created_by
      • Run.created_at
      • Run.labels
      • Run.custom_temperature
      • Run.custom_max_tokens
      • Run.custom_prompt_truncation_options
      • Run.custom_response_format
  • Search indexes domain
    • SearchIndexes
      • SearchIndexes.create_deferred()
      • SearchIndexes.get()
      • SearchIndexes.list()
    • SearchIndex
      • SearchIndex.update()
      • SearchIndex.delete()
      • SearchIndex.get_file()
      • SearchIndex.list_files()
      • SearchIndex.add_files_deferred()
      • SearchIndex.folder_id
      • SearchIndex.name
      • SearchIndex.description
      • SearchIndex.created_by
      • SearchIndex.created_at
      • SearchIndex.updated_by
      • SearchIndex.updated_at
      • SearchIndex.expires_at
      • SearchIndex.labels
      • SearchIndex.index_type
      • SearchIndex.expiration_config
      • SearchIndex.id
  • Search API domain
    • SearchAPIDomain
      • SearchAPIDomain.generative
      • SearchAPIDomain.web
      • SearchAPIDomain.image
      • SearchAPIDomain.by_image
    • Generative search
      • GenerativeSearchFunction
        • GenerativeSearchFunction.__call__()
        • GenerativeSearchFunction.available_formats
      • GenerativeSearch
        • GenerativeSearch.run()
        • GenerativeSearch.as_tool()
        • GenerativeSearch.config
        • GenerativeSearch.configure()
        • GenerativeSearch.uri
    • Web search
      • WebSearchFunction
        • WebSearchFunction.__call__()
      • WebSearch
        • WebSearch.config
        • WebSearch.configure()
        • WebSearch.uri
        • WebSearch.run()
        • WebSearch.run_deferred()
      • WebSearchResult
        • WebSearchResult.next_page()
        • WebSearchResult.next_page_deferred()
        • WebSearchResult.count()
        • WebSearchResult.docs
        • WebSearchResult.index()
        • WebSearchResult.xml
        • WebSearchResult.groups
        • WebSearchResult.page
    • Image search
      • ImageSearchFunction
        • ImageSearchFunction.__call__()
      • ImageSearch
        • ImageSearch.config
        • ImageSearch.configure()
        • ImageSearch.uri
        • ImageSearch.run()
      • ImageSearchResult
        • ImageSearchResult.next_page()
        • ImageSearchResult.count()
        • ImageSearchResult.docs
        • ImageSearchResult.index()
        • ImageSearchResult.xml
        • ImageSearchResult.groups
        • ImageSearchResult.page
    • Search by image
      • ByImageSearchFunction
        • ByImageSearchFunction.__call__()
      • ByImageSearch
        • ByImageSearch.run()
        • ByImageSearch.run_from_url()
        • ByImageSearch.run_from_id()
        • ByImageSearch.config
        • ByImageSearch.configure()
        • ByImageSearch.uri
      • ByImageSearchResult
        • ByImageSearchResult.next_page()
        • ByImageSearchResult.count()
        • ByImageSearchResult.docs
        • ByImageSearchResult.index()
        • ByImageSearchResult.images
        • ByImageSearchResult.cbir_id
        • ByImageSearchResult.page
  • Datasets domain
    • Datasets
      • Datasets.get()
      • Datasets.list()
      • Datasets.list_upload_formats()
      • Datasets.list_upload_schemas()
      • Datasets.completions
      • Datasets.draft_from_path()
      • Datasets.text_classifiers_binary
      • Datasets.text_classifiers_multiclass
      • Datasets.text_classifiers_multilabel
      • Datasets.text_embeddings_pair
      • Datasets.text_embeddings_triplet
    • Dataset
      • Dataset.update()
      • Dataset.delete()
      • Dataset.list_upload_formats()
      • Dataset.download()
      • Dataset.read()
      • Dataset.folder_id
      • Dataset.name
      • Dataset.description
      • Dataset.metadata
      • Dataset.created_by
      • Dataset.created_at
      • Dataset.updated_at
      • Dataset.labels
      • Dataset.allow_data_logging
      • Dataset.status
      • Dataset.task_type
      • Dataset.rows
      • Dataset.size_bytes
      • Dataset.validation_errors
      • Dataset.id
    • DatasetDraft
      • DatasetDraft.upload_deferred()
      • DatasetDraft.upload()
      • DatasetDraft.allow_data_logging
      • DatasetDraft.configure()
      • DatasetDraft.description
      • DatasetDraft.labels
      • DatasetDraft.metadata
      • DatasetDraft.name
      • DatasetDraft.path
      • DatasetDraft.task_type
      • DatasetDraft.upload_format
      • DatasetDraft.validate()
  • Tuning domain
    • Tuning
      • Tuning.get()
      • Tuning.list()
  • Batch domain
    • Batch
      • Batch.get()
      • Batch.list_operations()
      • Batch.list_info()
    • BatchTaskOperation
      • BatchTaskOperation.delete()
      • BatchTaskOperation.get_task_info()
      • BatchTaskOperation.cancel()
      • BatchTaskOperation.get_result()
      • BatchTaskOperation.get_status()
      • BatchTaskOperation.id
      • BatchTaskOperation.task_id
      • BatchTaskOperation.wait()
  • Chat domain
    • Chat
      • Chat.completions
      • Chat.text_embeddings

Была ли статья полезна?

Предыдущая
Overview
Следующая
Models domain
Проект Яндекса
© 2025 ООО «Яндекс.Облако»