Skip to main content

Multimodal SDK for working with Yandex AI Studio services

Project description

Yandex AI Studio SDK

This Python library provides a simple and efficient software development kit (SDK) for interacting with Yandex Cloud AI Studio services. The SDK abstracts away the complexities of raw gRPC and REST calls, making it easier for developers to integrate cloud functionality into their applications seamlessly.

Features

Yandex AI Studio SDK offers a comprehensive set of high‑level abstractions that map directly to the capabilities exposed by Yandex Cloud. The current feature set includes:

  • Assistants
    • Create, list, update and delete AI assistants.
    • Create and track execution of assistant runs, retrieve logs and results.
  • Completions
    • Text generation (completion) models with streaming support.
    • Chat usage tracking, tool calls (function calling for example).
  • Chat
    • OpenAI‑compatible chat API (sdk.chat) designed to work seamlessly with the rest of the Yandex AI Studio SDK.
    • Send and receive messages, stream responses, and work with tool calls in a unified way.
  • Image generation
    • Generate images via YandexART models.
  • Text embeddings
    • Compute dense vector embeddings for arbitrary text.
  • Text classifiers
    • Run multi‑class, multi‑label and binary classifiers.
  • Files
    • Upload, download, list and delete files stored in Yandex Cloud AI Studio.
  • Threads
    • Organize conversations into threads, retrieve messages, and post new messages.
  • Search API
    • Generative, web, image and by image search.
  • Search indexes
    • Create, update, delete and query text, vector and hybrid search indexes.

Also there is some cross-domain functionality for features above:

  • Batch processing
    • Run long‑running batch tasks with automatic polling.
  • Tools
    • Built‑in tools such as Generative Search Tool, Function Tool and Search Index Tool that can be used in Assistants, Completions, and Chat, providing a unified way to extend functionality across the SDK.
  • Tuning
    • Fine‑tune models with configurable optimizers, schedulers and other hyper‑parameters.
  • Datasets
    • Manage dataset lifecycle, upload data, validate schemas, and perform task‑type specific operations.

Additionally, Yandex AI Studio SDK offers:

  • Authentication
    • Automatic selection of authentication method (API key, IAM token, OAuth token, CLI, metadata service, etc.).
  • Error handling & retries
    • Rich exception hierarchy, retry policies, and configurable gRPC interceptors.
  • Async & sync support
    • Every high‑level service is available in both asynchronous and synchronous variants.
  • LangChain integration
    • Ready‑to‑use wrappers for LangChain (.langchain()) with an optional extra installation.

Installation

You can install the library via pip:

pip install yandex-ai-studio-sdk

SDK Reference

https://yandex.cloud/docs/ai-studio/sdk-ref/

Usage

Here's a basic example of how to use the SDK:

from yandex_ai_studio_sdk import AIStudio

sdk = AIStudio(folder_id="...", auth="<APIKey/IAMToken/SomethingElse>")

model = sdk.models.completions('yandexgpt')
model = model.configure(temperature=0.5)
result = model.run("foo")

for alternative in result:
    print(alternative)

For more usage examples look into examples folder.

LangChain integration

To use LangChain integration, install yandex-ai-studio-sdk package with a langchain extra:

pip install yandex-ai-studio-sdk[langchain]

Usage example:

from yandex_ai_studio_sdk import AIStudio
from langchain_core.messages import AIMessage, HumanMessage

sdk = AIStudio(folder_id="...", auth="<APIKey/IAMToken/SomethingElse>")

model = sdk.models.completions('yandexgpt').langchain()

langchain_result = model.invoke([
    HumanMessage(content="hello!"),
    AIMessage(content="Hi there human!"),
    HumanMessage(content="Meow!"),
])

For more LangChain integration examples look into examples/langchain folder.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yandex_ai_studio_sdk-0.19.1.tar.gz (173.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yandex_ai_studio_sdk-0.19.1-py3-none-any.whl (266.3 kB view details)

Uploaded Python 3

File details

Details for the file yandex_ai_studio_sdk-0.19.1.tar.gz.

File metadata

  • Download URL: yandex_ai_studio_sdk-0.19.1.tar.gz
  • Upload date:
  • Size: 173.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for yandex_ai_studio_sdk-0.19.1.tar.gz
Algorithm Hash digest
SHA256 970cc6b49635492b30274c62eac986e16dc011adf1082475e9b634dcd80d0e36
MD5 5582a559d0bbac32b96eb14b1cda17ac
BLAKE2b-256 4b8f1637fc0e303739679aa5275ef05dfbfd38935e0c54d955aea4a43529a72e

See more details on using hashes here.

File details

Details for the file yandex_ai_studio_sdk-0.19.1-py3-none-any.whl.

File metadata

File hashes

Hashes for yandex_ai_studio_sdk-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7db0a44b63b9fda93f4f7d0e57e49cd740fdd5834704f84c2d6d7f3b7b7d2580
MD5 830b2e118cb533d7f104e9b273b6d6f9
BLAKE2b-256 f0b828b56b4786483d21db6e23952e0e2555d8113d885b9aa743ca0e132b99e4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page