It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- 🛠 Make your SDK feel handcrafted by customizing it
- ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
- 🎁 Publish your SDK to package managers by configuring automatic publishing
- ✨ When ready to productionize, delete this section from the README
PIP
pip install git+<UNSET>.gitPoetry
poetry add git+<UNSET>.gitThis example shows how to create chat completions.
# Synchronous Example
import beezy_ai
from beezy_ai import BeezyAI
import os
s = BeezyAI(
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = s.chat.stream(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
if res is not None:
for event in res:
# handle event
print(event)The same SDK client can also be used to make asychronous requests by importing asyncio.
# Asynchronous Example
import asyncio
import beezy_ai
from beezy_ai import BeezyAI
import os
async def main():
s = BeezyAI(
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = await s.chat.stream_async(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
if res is not None:
for event in res:
# handle event
print(event)
asyncio.run(main())- create - Create FIM Completions
- create - Create Embeddings
- list - List Available Models
- list_jobs - List Fine Tuning Jobs
- create_job - Create Fine Tuning Job
- get_job - Get Fine Tuning Job
- cancel_job - Cancel Fine Tuning Job
Server-sent events are used to stream content from certain
operations. These operations will expose the stream as Generator that
can be consumed using a simple for loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
import beezy_ai
from beezy_ai import BeezyAI
import os
s = BeezyAI(
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = s.chat.stream(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
if res is not None:
for event in res:
# handle event
print(event)Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| models.BadRequest | 400 | application/json |
| models.Unauthorized | 401 | application/json |
| models.Forbidden | 403 | application/json |
| models.NotFound | 404 | application/json |
| models.TooManyRequests | 429 | application/json |
| models.InternalServerError | 500 | application/json |
| models.ServiceUnavailable | 503 | application/json |
| models.SDKError | 4xx-5xx | / |
import beezy_ai
from beezy_ai import BeezyAI, models
import os
s = BeezyAI(
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = None
try:
res = s.chat.stream(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
except models.BadRequest as e:
# handle exception
raise(e)
except models.Unauthorized as e:
# handle exception
raise(e)
except models.Forbidden as e:
# handle exception
raise(e)
except models.NotFound as e:
# handle exception
raise(e)
except models.TooManyRequests as e:
# handle exception
raise(e)
except models.InternalServerError as e:
# handle exception
raise(e)
except models.ServiceUnavailable as e:
# handle exception
raise(e)
except models.SDKError as e:
# handle exception
raise(e)
if res is not None:
for event in res:
# handle event
print(event)You can override the default server globally by passing a server name to the server: str optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Variables |
|---|---|---|
prod |
https://api.beezy.ai/v1 |
None |
import beezy_ai
from beezy_ai import BeezyAI
import os
s = BeezyAI(
server="prod",
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = s.chat.stream(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
if res is not None:
for event in res:
# handle event
print(event)The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
import beezy_ai
from beezy_ai import BeezyAI
import os
s = BeezyAI(
server_url="https://api.beezy.ai/v1",
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = s.chat.stream(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
if res is not None:
for event in res:
# handle event
print(event)The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.
For example, you could specify a header for every request that this sdk makes as follows:
from beezy_ai import BeezyAI
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = BeezyAI(client=http_client)or you could wrap the client with your own custom logic:
from beezy_ai import BeezyAI
from beezy_ai.httpclient import AsyncHttpClient
import httpx
class CustomClient(AsyncHttpClient):
client: AsyncHttpClient
def __init__(self, client: AsyncHttpClient):
self.client = client
async def send(
self,
request: httpx.Request,
*,
stream: bool = False,
auth: Union[
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
] = httpx.USE_CLIENT_DEFAULT,
follow_redirects: Union[
bool, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
request.headers["Client-Level-Header"] = "added by client"
return await self.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
def build_request(
self,
method: str,
url: httpx._types.URLTypes,
*,
content: Optional[httpx._types.RequestContent] = None,
data: Optional[httpx._types.RequestData] = None,
files: Optional[httpx._types.RequestFiles] = None,
json: Optional[Any] = None,
params: Optional[httpx._types.QueryParamTypes] = None,
headers: Optional[httpx._types.HeaderTypes] = None,
cookies: Optional[httpx._types.CookieTypes] = None,
timeout: Union[
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
] = httpx.USE_CLIENT_DEFAULT,
extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
return self.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s = BeezyAI(async_client=CustomClient(httpx.AsyncClient()))This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
api_key_auth |
http | HTTP Bearer |
To authenticate with the API the api_key_auth parameter must be set when initializing the SDK client instance. For example:
import beezy_ai
from beezy_ai import BeezyAI
import os
s = BeezyAI(
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = s.chat.stream(request={
"model": "beezy-small-latest",
"messages": [
{
"role": beezy_ai.ChatCompletionRole.USER,
"content": "Who is the best French painter? Answer in JSON.",
},
],
"response_format": {
"type": "json_object",
},
"max_tokens": 512,
"random_seed": 1337,
})
if res is not None:
for event in res:
# handle event
print(event)Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
Tip
For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
from beezy_ai import BeezyAI
import os
s = BeezyAI(
api_key_auth=os.getenv("API_KEY_AUTH", ""),
)
res = s.files.upload(purpose="fine-tune", file={
"file_name": "your_file_here",
"content": open("<file_path>", "rb"),
})
if res is not None:
# handle response
passThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.