YUA AI SDK — OpenAI-compatible Python client
Project description
yua
Official Python SDK for YUA AI. YUA AI Python SDK.
Installation
pip install yua
Quick Start
from yua import YUA
client = YUA(api_key="yua_sk_...")
# Streaming
stream = client.chat.completions.create(
model="yua-normal",
messages=[{"role": "user", "content": "Hello!"}],
stream=True,
)
for chunk in stream:
text = chunk.choices[0].delta.content
if text:
print(text, end="", flush=True)
Non-Streaming
response = client.chat.completions.create(
model="yua-normal",
messages=[{"role": "user", "content": "What is 2+2?"}],
)
print(response.choices[0].message.content)
Models
| Model | Description |
|---|---|
yua-fast |
Fast responses, single segment |
yua-normal |
Balanced speed and quality (default) |
yua-deep |
Deep reasoning with multi-step thinking |
Configuration
client = YUA(
api_key="yua_sk_...", # Required (or auth_provider)
base_url="https://...", # Default: https://api.yuaone.com
workspace="ws_...", # Optional workspace ID
timeout=30.0, # Request timeout in seconds (default: 30)
max_retries=2, # Auto-retry count (default: 2)
)
Context Manager
with YUA(api_key="yua_sk_...") as client:
stream = client.chat.completions.create(...)
for chunk in stream:
...
# Connection automatically closed
Custom Auth Provider
client = YUA(
auth_provider=lambda: get_id_token(),
)
Streaming with YUA Events
YUA streams include extended events beyond standard text chunks.
stream = client.chat.completions.create(
model="yua-deep",
messages=[{"role": "user", "content": "Explain quantum computing"}],
stream=True,
thinking_profile="DEEP",
)
for chunk in stream:
# Standard text content
text = chunk.choices[0].delta.content
if text:
print(text, end="", flush=True)
# YUA-specific events
if chunk.yua_event:
if chunk.yua_event.type == "activity":
print(f"[Activity] {chunk.yua_event.data}")
elif chunk.yua_event.type == "reasoning_block":
print(f"[Reasoning] {chunk.yua_event.data}")
elif chunk.yua_event.type == "suggestion":
print(f"[Suggestions] {chunk.yua_event.data}")
Stream Helper Methods
stream = client.chat.completions.create(..., stream=True)
# Get full text after stream completes
full_text = stream.text_content()
# Get the final assembled message
message = stream.final_message()
Thread Management
# Create thread
thread = client.chat.threads.create()
# List threads
threads = client.chat.threads.list()
# Send message to specific thread
stream = client.chat.completions.create(
model="yua-normal",
messages=[{"role": "user", "content": "Continue our discussion"}],
stream=True,
thread_id=thread["threadId"],
)
# Update thread title
client.chat.threads.update(thread["threadId"], title="My Chat")
# Delete thread
client.chat.threads.delete(thread["threadId"])
Messages
# List messages in a thread
messages = client.chat.messages.list(thread_id=123)
# Send a message without streaming
client.chat.messages.create(
thread_id=123,
role="user",
content="Hello",
)
Error Handling
from yua import APIError, AuthenticationError, RateLimitError
try:
res = client.chat.completions.create(...)
except AuthenticationError:
print("Invalid API key")
except RateLimitError:
print("Rate limited, retry later")
except APIError as e:
print(f"{e.status} {e.code}: {e.message}")
YUA Event Types
| Event | Description |
|---|---|
stage |
Processing stage changes (thinking, analyzing, answer) |
token |
Text token (mapped to delta.content) |
final |
Final assembled response (mapped to finish_reason="stop") |
activity |
Thinking activities (analyzing, planning, researching) |
reasoning_block |
Deep reasoning block content |
reasoning_done |
Reasoning phase completed |
suggestion |
Follow-up suggestions |
memory |
Memory commit events |
answer_unlocked |
Deep mode: answer text begins |
Extensibility
Stream Event Listeners
Use .on() for granular event handling during streaming:
stream = client.chat.completions.create(
model="yua-deep",
messages=[{"role": "user", "content": "Analyze this"}],
stream=True,
)
stream.on("stage", lambda stage: print(f"[Stage] {stage}"))
stream.on("activity", lambda data: print(f"[{data['op']}] {data['item']['title']}"))
stream.on("reasoning_block", lambda block: print(f"[Think] {block['title']}"))
stream.on("suggestion", lambda items: print("Suggestions:", items))
stream.on("memory", lambda payload: print(f"[Memory] {payload['op']}"))
for chunk in stream:
text = chunk.choices[0].delta.content
if text:
print(text, end="", flush=True)
Model Selection
Choose the right model for your use case:
# Fast: simple responses, translation, summarization
client.chat.completions.create(model="yua-fast", ...)
# Normal: general purpose (default)
client.chat.completions.create(model="yua-normal", ...)
# Deep: multi-step reasoning and analysis
client.chat.completions.create(model="yua-deep", ...)
# Search: web search optimized
client.chat.completions.create(model="yua-search", ...)
Conversation Continuity (Threads)
Maintain context across multiple turns using threads:
thread = client.chat.threads.create()
# First message
client.chat.completions.create(
model="yua-normal",
messages=[{"role": "user", "content": "What is GDP?"}],
stream=True,
thread_id=thread["threadId"],
)
# Follow-up in same thread — server retains full context
client.chat.completions.create(
model="yua-normal",
messages=[{"role": "user", "content": "Compare Korea and Japan"}],
stream=True,
thread_id=thread["threadId"],
)
Workspace Isolation
Scope API calls to a specific workspace for team/project separation:
client = YUA(
api_key="yua_sk_...",
workspace="ws_team_abc",
)
# All requests are scoped to this workspace
Aggregated Extension Data
After streaming completes, access all collected YUA extension data:
stream = client.chat.completions.create(..., stream=True)
message = stream.final_message()
print(message.yua.activities) # Full thinking timeline
print(message.yua.suggestions) # Follow-up suggestions
print(message.yua.reasoning_blocks) # Deep reasoning blocks
print(message.yua.memory_ops) # Memory operations
Custom Auth Provider
Use dynamic token resolution instead of a static API key:
client = YUA(
auth_provider=lambda: get_fresh_token(),
)
# Token is resolved on each request
Embeddings
Convert text into high-dimensional vectors for search, similarity comparison, classification, and RAG.
Basic Usage
result = client.embeddings.create(
model="yua-embed-small",
input="삼성전자 주가 분석",
)
print(result.data[0].embedding) # list[float] (1536 dims)
print(result.usage.total_tokens) # 6
Batch Embedding
result = client.embeddings.create(
model="yua-embed-small",
input=[
"삼성전자 주가 분석",
"애플 실적 전망",
"테슬라 자율주행 기술",
],
)
result.data[0].embedding # first text vector
result.data[1].embedding # second text vector
result.data[2].embedding # third text vector
Dimension Control
# Reduce dimensions for cost/speed optimization
result = client.embeddings.create(
model="yua-embed-small",
input="텍스트",
dimensions=512, # default 1536 → reduced to 512
)
Embedding Models
| Model | Dimensions | Max Tokens | Use Case |
|---|---|---|---|
yua-embed-small |
1536 | 8192 | General purpose (search, RAG, memory) |
yua-embed-large |
3072 | 8192 | High precision (legal, medical, finance) |
Response Types
class EmbeddingResponse:
object: str # "list"
model: str # model name
data: list[EmbeddingObject]
usage: EmbeddingUsage
class EmbeddingObject:
object: str # "embedding"
index: int # position in input array
embedding: list[float] # float vector
class EmbeddingUsage:
prompt_tokens: int
total_tokens: int
OpenAI Compatible
Drop-in replacement — works with existing OpenAI SDK:
from openai import OpenAI
client = OpenAI(
api_key="yua_sk_...",
base_url="https://api.yuaone.com/api/v1",
)
res = client.embeddings.create(
model="yua-embed-small",
input="텍스트",
)
TypeScript Types
All types are fully exported:
from yua import (
# Chat
ChatCompletion,
ChatCompletionChunk,
ChatCompletionChoice,
ChatCompletionChunkChoice,
ChatCompletionDelta,
ChatCompletionMessage,
ChatMessageInput,
CompletionUsage,
YuaExtension,
YuaStreamEvent,
# Embedding
EmbeddingResponse,
EmbeddingObject,
EmbeddingUsage,
)
Requirements
- Python >= 3.8
- httpx >= 0.24.0
- pydantic >= 2.0.0
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yua-0.3.0.tar.gz.
File metadata
- Download URL: yua-0.3.0.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fb42deb64401b25aa64c697a4c7731a40a49fe826739afa7fbe6b7e24067f210
|
|
| MD5 |
36f1fa9b96109e326311b4b1030caa4d
|
|
| BLAKE2b-256 |
bed1eddeeed96b4a7d176060fe5730a41a3107bc5e9be38cfc41507680026e28
|
File details
Details for the file yua-0.3.0-py3-none-any.whl.
File metadata
- Download URL: yua-0.3.0-py3-none-any.whl
- Upload date:
- Size: 16.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
deab2008130278c6f26711a7ee360dff92cf1f5440c7798d1cc36fb06ab098e6
|
|
| MD5 |
c00097e5a41e76fd15707fee55a997fe
|
|
| BLAKE2b-256 |
a061b72a205c8d9e018c3979f839ded6993856c1a1ffdc8139c93ef58dc30d8a
|