syllable-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage syllable-sdk API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

SyllableSDK:

Syllble Platform SDK

Syllble SDK gives you the power of awesome AI agentry. 🚀

Overview

The Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered.

Features

Natural Language Processing (NLP): Understand and generate human language with ease.
Machine Learning Models: Leverage pre-trained models or train your own custom models.
Speech Recognition: Convert speech to text and vice versa.
Image Recognition: Identify objects, faces, and scenes in images.
Data Analytics: Analyze and visualize data to gain insights.
Integration: Seamlessly integrate with other services and platforms.

SDK Installation

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
import os
from syllable_sdk import Syllable

s = Syllable(
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = s.agents.list()

if res is not None:
    # handle response
    pass

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
import os
from syllable_sdk import Syllable

async def main():
    s = Syllable(
        api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
    )
    res = await s.agents.list_async()
    if res is not None:
        # handle response
        pass

asyncio.run(main())

Available Resources and Operations

Available methods

agents

list - Agent List
create - Create Agent
update - Update Agent
get_by_id - Get Agent By Id
delete - Delete Agent

agents.chats

send_message - Send New Message

channels

list - Get Channels
delete - Delete Channel

channels.available_targets

list - Available Targets List

channels.targets

list - Get Channel Targets
create - Assign A Channel Target
get_by_id - Get A Channel Target
update - Edit Channel Target

conversations

list - Conversations List
get - Get Conversation By Id

dashboards

get_total_call_volume_by_weekday - Get Total Call Volume By Weekday
get_total_call_volume_by_hour - Get Total Call Volume By Hour
get_weekly_call_volume_by_weekday - Get Weekly Call Volume By Weekday
get_daily_call_volume_by_hour - Get Daily Call Volume By Hour
get_monthly_call_volume_by_week - Get Monthly Call Volume By Week
get_monthly_call_volume_by_day - Get Monthly Call Volume By Day
get_session_summary - Get Session Summary
get_session_agents - Get Agents

events

list - Events List

greetings

list - Greetings List
create - Create Greeting
update - Update Greeting
get_by_id - Get Greeting By Id
delete - Delete Greeting

organizations

list - Organizations List

prompts

list - Prompt List
create - Create Prompt
update - Update Prompt
get_by_id - Get Prompt By Id
delete - Delete Prompt

sessions

list - Sessions List

tools

list - Tool List
get_by_name - Tool Info

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

import os
from syllable.utils import BackoffStrategy, RetryConfig
from syllable_sdk import Syllable

s = Syllable(
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = s.agents.list(,
    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

if res is not None:
    # handle response
    pass

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

import os
from syllable.utils import BackoffStrategy, RetryConfig
from syllable_sdk import Syllable

s = Syllable(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = s.agents.list()

if res is not None:
    # handle response
    pass

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.SDKError exception, which has the following properties:

Property	Type	Description
`.status_code`	int	The HTTP status code
`.message`	str	The error message
`.raw_response`	httpx.Response	The raw HTTP response
`.body`	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list_async method may raise the following exceptions:

Error Type	Status Code	Content Type
models.HTTPValidationError	422	application/json
models.SDKError	4XX, 5XX	/

Example

import os
from syllable_sdk import Syllable, models

s = Syllable(
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = None
try:
    res = s.agents.list()

    if res is not None:
        # handle response
        pass

except models.HTTPValidationError as e:
    # handle e.data: models.HTTPValidationErrorData
    raise(e)
except models.SDKError as e:
    # handle exception
    raise(e)

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int 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 indexes associated with the available servers:

#	Server	Variables
0	`http://localhost:8001`	None

Example

import os
from syllable_sdk import Syllable

s = Syllable(
    server_idx=0,
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = s.agents.list()

if res is not None:
    # handle response
    pass

Override Server URL Per-Client

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 os
from syllable_sdk import Syllable

s = Syllable(
    server_url="http://localhost:8001",
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = s.agents.list()

if res is not None:
    # handle response
    pass

Custom HTTP Client

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 syllable_sdk import Syllable
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Syllable(client=http_client)

or you could wrap the client with your own custom logic:

from syllable_sdk import Syllable
from syllable_sdk.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 = Syllable(async_client=CustomClient(httpx.AsyncClient()))

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`api_key_header`	apiKey	API key	`SYLLABLE_API_KEY_HEADER`

To authenticate with the API the api_key_header parameter must be set when initializing the SDK client instance. For example:

import os
from syllable_sdk import Syllable

s = Syllable(
    api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
)

res = s.agents.list()

if res is not None:
    # handle response
    pass

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from syllable_sdk import Syllable
import logging

logging.basicConfig(level=logging.DEBUG)
s = Syllable(debug_logger=logging.getLogger("syllable_sdk"))

You can also enable a default debug logger by setting an environment variable SYLLABLE_DEBUG to true.

Development

Maturity

This 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.

Contributions

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.

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
api-reference		api-reference
essentials		essentials
images		images
logo		logo
snippets		snippets
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
USAGE.md		USAGE.md
development.mdx		development.mdx
favicon.svg		favicon.svg
introduction.mdx		introduction.mdx
mint.json		mint.json
quickstart.mdx		quickstart.mdx
syllable_logo_svg.svg		syllable_logo_svg.svg

Folders and files

Latest commit

History

Repository files navigation

syllable-sdk

Summary

Syllble Platform SDK

Overview

Features

Table of Contents

SDK Installation

PIP

Poetry

IDE Support

PyCharm

SDK Example Usage

Example

Available Resources and Operations

Retries

Error Handling

Example

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages