API Reference
CygnisAI Python SDK ~~~~~~~~~~~~~~~~~~~
Simple, fast access to CygnisAI language models.
Quick-start::
import cygnisai_sdk_python as cygnis
cygnis.configure(api_key="YOUR_KEY")
model = cygnis.GenerativeModel("alpha2")
response = model.generate_content("Give me a Python tip.")
print(response.text)
Streaming::
stream = model.generate_content("Tell me a story.", stream=True)
async for token in stream:
print(token, end="", flush=True)
AuthenticationError
Bases: CygnisAIError
Raised on HTTP 401 / 403.
Source code in cygnisai_sdk_python/client.py
45 46 | |
ChatRequest
Bases: BaseModel
Payload sent to POST /v3/chat.
Source code in cygnisai_sdk_python/models.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | |
ChatResponse
Bases: BaseModel
Successful non-streaming response from POST /v3/chat.
Source code in cygnisai_sdk_python/models.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | |
CygnisAIClient
Async HTTP client for the CygnisAI API.
Can be used as an async context manager::
async with CygnisAIClient(api_key="...") as client:
response = await client.chat(request)
Or managed manually::
client = CygnisAIClient(api_key="...")
try:
...
finally:
await client.close()
Source code in cygnisai_sdk_python/client.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 | |
chat(request)
async
Send a chat request and return the complete response.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ChatRequest
|
A :class: |
required |
Returns:
| Type | Description |
|---|---|
ChatResponse
|
class: |
Raises:
| Type | Description |
|---|---|
AuthenticationError
|
On 401/403. |
RateLimitError
|
On 429. |
ServerError
|
On 5xx. |
NetworkError
|
On connection failure. |
ResponseValidationError
|
If the response body doesn't match the schema. |
CygnisAIError
|
For any other API error. |
Source code in cygnisai_sdk_python/client.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | |
chat_stream(request)
async
Send a chat request and yield tokens as they arrive (SSE).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ChatRequest
|
A :class: |
required |
Yields:
| Type | Description |
|---|---|
AsyncGenerator[str, None]
|
str – individual text tokens from the model. |
Raises:
| Type | Description |
|---|---|
CygnisAIError (and subclasses)
|
as documented on :meth: |
Source code in cygnisai_sdk_python/client.py
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 | |
close()
async
Release the underlying HTTP connection pool.
Source code in cygnisai_sdk_python/client.py
161 162 163 164 | |
CygnisAIError
Bases: Exception
Base exception for all CygnisAI SDK errors.
Source code in cygnisai_sdk_python/client.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | |
ErrorResponse
Bases: BaseModel
Standardised error envelope returned by the API.
Source code in cygnisai_sdk_python/models.py
97 98 99 100 101 102 103 104 | |
GenerativeModel
High-level interface for a CygnisAI language model.
Uses the global client configured via :func:configure.
Example::
model = GenerativeModel("alpha2")
response = model.generate_content("Hello!")
print(response.text)
Source code in cygnisai_sdk_python/__init__.py
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | |
async_generate_content(prompt, messages=None, stream=False)
async
Async version of :meth:generate_content for use inside async code.
Example::
response = await model.async_generate_content("Hello!")
Source code in cygnisai_sdk_python/__init__.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | |
generate_content(prompt, messages=None, stream=False)
Generate text from a prompt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
prompt
|
str
|
The question or instruction for the model. |
required |
messages
|
Optional[List[Message]]
|
Optional conversation history. |
None
|
stream
|
bool
|
If |
False
|
Returns:
| Type | Description |
|---|---|
Any
|
class: |
Any
|
class: |
Source code in cygnisai_sdk_python/__init__.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
GenerativeResponse
Wraps a completed :class:~cygnisai_sdk_python.models.ChatResponse.
Source code in cygnisai_sdk_python/__init__.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | |
full_response
property
The raw :class:~cygnisai_sdk_python.models.ChatResponse, if available.
latency_ms
property
Round-trip latency reported by the API.
usage
property
Token-usage statistics, if available.
GenerativeStreamResponse
Wraps an async token generator from :meth:CygnisAIClient.chat_stream.
Source code in cygnisai_sdk_python/__init__.py
90 91 92 93 94 95 96 97 | |
Message
Bases: BaseModel
A single turn in a conversation.
Source code in cygnisai_sdk_python/models.py
30 31 32 33 34 35 36 | |
NetworkError
Bases: CygnisAIError
Raised when the request never reaches the server.
Source code in cygnisai_sdk_python/client.py
57 58 | |
RateLimitError
Bases: CygnisAIError
Raised on HTTP 429.
Source code in cygnisai_sdk_python/client.py
49 50 | |
ResponseValidationError
Bases: CygnisAIError
Raised when the API response doesn't match the expected schema.
Source code in cygnisai_sdk_python/client.py
61 62 | |
Role
Bases: str, Enum
Valid message roles.
Source code in cygnisai_sdk_python/models.py
19 20 21 22 23 | |
ServerError
Bases: CygnisAIError
Raised on HTTP 5xx.
Source code in cygnisai_sdk_python/client.py
53 54 | |
UsageInfo
Bases: BaseModel
Token-usage breakdown returned by the API.
Source code in cygnisai_sdk_python/models.py
39 40 41 42 43 44 45 46 47 | |
configure(api_key=None, base_url=None, timeout=30.0, max_retries=3)
Initialise the global CygnisAI client.
Call this once at startup before using :class:GenerativeModel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
api_key
|
Optional[str]
|
Your CygnisAI API key. Falls back to the |
None
|
base_url
|
Optional[str]
|
Override the default API base URL. |
None
|
timeout
|
float
|
HTTP timeout in seconds (default 30). |
30.0
|
max_retries
|
int
|
Number of automatic retries on transient errors (default 3). |
3
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If no API key is found. |
Source code in cygnisai_sdk_python/__init__.py
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | |