opperai

Summary

Welcome to the OpperAI python SDK

Opper is a task completion platform for building reliable AI integrations. The Opper platform builds a happy path for declarative programming with AI models, combined with in context reinforcement learning, observability and cost tracking all in one platform - for reliable results in no time!

This SDK is generated using Speakeasy, read our detailed docs with many guides and examples at

SDK Installation

PIP

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

pip install opperai

Poetry / UV

If you use UV

uv add opperai

Poetry

poetry add opperai

SDK Example Usage

First steps

Log in at opper and create your own API key in the top right menu. Each api key is associated with a project, you will have all calls, functions, indexes and traces associated with this project. There is a default project for each organization but it is recommended to create a new project to better being able to separate the different applications and environments.

For many examples and guides of how to use our sdks check out our examples folder examples

Example

from opperai import Opper
# Our SDK supports Pydantic to provide structured output
from pydantic import BaseModel
import os

# Define the output structure
class RoomDescription(BaseModel):
    room_count: int
    view: str
    bed_size: str
    hotel_name: str

def main():
    opper = Opper(http_bearer=os.getenv("OPPER_API_KEY"))

    # Complete a task
    completion = opper.call(
        name="extractRoom",
        instructions="Extract details about the room from the provided text",
        input="The Grand Hotel offers a luxurious suite with 3 spacious rooms, each providing a breathtaking view of the ocean. The suite includes a king-sized bed, an en-suite bathroom, and a private balcony for an unforgettable stay.",
        output_schema=RoomDescription,
    )

    print(completion.json_payload)
    #{'room_count': 3, 'view': 'ocean', 'bed_size': 'king-sized', 'hotel_name': 'The Grand Hotel'}

main()

The same SDK client can also be used to make asychronous requests by importing asyncio. Just add _async to the call

Async example

# Asynchronous Example
import asyncio
import os
from opperai import Opper
from pydantic import BaseModel

# Define the output structure
class RoomDescription(BaseModel):
    room_count: int
    view: str
    bed_size: str
    hotel_name: str

async def main():
    opper = Opper(http_bearer=os.getenv("OPPER_API_KEY"))

    # Complete a task asynchronously
    completion = await opper.call_async(
        name="extractRoom",
        instructions="Extract details about the room from the provided text",
        input="The Grand Hotel offers a luxurious suite with 3 spacious rooms, each providing a breathtaking view of the ocean. The suite includes a king-sized bed, an en-suite bathroom, and a private balcony for an unforgettable stay.",
        output_schema=RoomDescription,
    )

    print(completion.json_payload)
    # {'room_count': 3, 'view': 'ocean', 'bed_size': 'king-sized', 'hotel_name': 'The Grand Hotel'}

# Run the async main function
asyncio.run(main())

Authentication

See our authenthication docs auth

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`http_bearer`	http	HTTP Bearer	`OPPER_HTTP_BEARER`

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

from opperai import Opper
import os

http_bearer="YOUR_API_KEY"
opper = Opper(http_bearer)

Available Resources and Operations

Available methods

analytics

get_usage - Usage

datasets

create_entry - Create Dataset Entry
list_entries - List Dataset Entries
get_entry - Get Dataset Entry
delete_entry - Delete Dataset Entry
query_entries - Query Dataset Entries

datasets.entries

update - Update Dataset Entry

embeddings

create - Create Embedding

functions

create - Create Function
list - List Functions
get - Get Function
update - Update Function
delete - Delete Function
get_by_name - Get Function By Name
get_by_revision - Get Function By Revision
call - Call Function
stream - Stream Function
call_revision - Call Function Revision
stream_revision - Stream Function Revision

functions.revisions

list - List Function Revisions

knowledge

create - Create Knowledge Base
list - List Knowledge Bases
get - Get Knowledge Base
delete - Delete Knowledge Base
get_by_name - Get Knowledge Base By Name
get_upload_url - Get Upload Url
register_file_upload - Register File Upload
delete_file - Delete File From Knowledge Base
query - Query Knowledge Base
add - Add

language_models

list - List Models
register_custom - Register Custom Model
list_custom - List Custom Models
get_custom - Get Custom Model
update_custom - Update Custom Model
delete_custom - Delete Custom Model
get_custom_by_name - Get Custom Model By Name

Opper SDK

call - Function Call
stream - Function Stream

span_metrics

create_metric - Create Metric
list - List Metrics
get - Get Metric
update_metric - Update Metric
delete - Delete Metric

spans

create - Create Span
get - Get Span
update - Update Span
delete - Delete Span
save_examples - Save To Dataset

traces

list - List Traces
get - Get Trace

Server-sent event streaming

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.

from opperai import Opper
import os


opper = Opper(http_bearer=os.getenv("OPPER_API_KEY"))

def stream_call():
    """Print the assistant’s answer as it streams back from Opper."""
    outer = opper.stream(
        name="python/sdk/bare-minimum-with-stream",
        instructions="answer the following question",
        input="what are some uses of 42",
    )

    # Pull out the inner EventStream object in one line.
    stream = next(value for key, value in outer if key == "result")

    # Read each Server-Sent Event and emit the delta text.
    for event in stream:  # event: ServerSentEvent
        delta = getattr(event.data, "delta", None)
        if delta:  # skip keep-alives, etc.
            print(delta, end="", flush=True)

The stream is also a Context Manager and can be used with the with statement and will close the underlying connection when the context is exited.

Context Manager Stream Example

from opperai import Opper
import os


with Opper(
    http_bearer=os.getenv("OPPER_HTTP_BEARER", ""),
) as opper:

    res = opper.stream(name="add_numbers", instructions="Calculate the sum of two numbers", input_schema={
        "properties": {
            "x": {
                "title": "X",
                "type": "integer",
            },
            "y": {
                "title": "Y",
                "type": "integer",
            },
        },
        "required": [
            "x",
            "y",
        ],
        "title": "OpperInputExample",
        "type": "object",
    }, output_schema={
        "properties": {
            "sum": {
                "title": "Sum",
                "type": "integer",
            },
        },
        "required": [
            "sum",
        ],
        "title": "OpperOutputExample",
        "type": "object",
    }, input={
        "x": 4,
        "y": 5,
    }, examples=[
        {
            "input": {
                "x": 1,
                "y": 3,
            },
            "output": {
                "sum": 4,
            },
            "comment": "Adds two numbers",
        },
    ], parent_span_id="123e4567-e89b-12d3-a456-426614174000", tags={
        "project": "project_456",
        "user": "company_123",
    }, configuration={})

    with res as event_stream:
        for event in event_stream:
            # handle event
            print(event, flush=True)

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:

from opperai import Opper
from opperai.utils import BackoffStrategy, RetryConfig
import os


with Opper(
    http_bearer=os.getenv("OPPER_HTTP_BEARER", ""),
) as opper:

    res = opper.call(name="add_numbers", instructions="Calculate the sum of two numbers", input_schema={
        "properties": {
            "x": {
                "title": "X",
                "type": "integer",
            },
            "y": {
                "title": "Y",
                "type": "integer",
            },
        },
        "required": [
            "x",
            "y",
        ],
        "title": "OpperInputExample",
        "type": "object",
    }, output_schema={
        "properties": {
            "sum": {
                "title": "Sum",
                "type": "integer",
            },
        },
        "required": [
            "sum",
        ],
        "title": "OpperOutputExample",
        "type": "object",
    }, input={
        "x": 4,
        "y": 5,
    }, examples=[
        {
            "input": {
                "x": 1,
                "y": 3,
            },
            "output": {
                "sum": 4,
            },
            "comment": "Adds two numbers",
        },
    ], parent_span_id="123e4567-e89b-12d3-a456-426614174000", tags={
        "project": "project_456",
        "user": "company_123",
    }, configuration={},
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

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:

from opperai import Opper
from opperai.utils import BackoffStrategy, RetryConfig
import os


with Opper(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    http_bearer=os.getenv("OPPER_HTTP_BEARER", ""),
) as opper:

    res = opper.call(name="add_numbers", instructions="Calculate the sum of two numbers", input_schema={
        "properties": {
            "x": {
                "title": "X",
                "type": "integer",
            },
            "y": {
                "title": "Y",
                "type": "integer",
            },
        },
        "required": [
            "x",
            "y",
        ],
        "title": "OpperInputExample",
        "type": "object",
    }, output_schema={
        "properties": {
            "sum": {
                "title": "Sum",
                "type": "integer",
            },
        },
        "required": [
            "sum",
        ],
        "title": "OpperOutputExample",
        "type": "object",
    }, input={
        "x": 4,
        "y": 5,
    }, examples=[
        {
            "input": {
                "x": 1,
                "y": 3,
            },
            "output": {
                "sum": 4,
            },
            "comment": "Adds two numbers",
        },
    ], parent_span_id="123e4567-e89b-12d3-a456-426614174000", tags={
        "project": "project_456",
        "user": "company_123",
    }, configuration={})

    # Handle response
    print(res)

Error Handling

Check our detailed 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 errors.APIError 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 call_async method may raise the following exceptions:

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.NotFoundError	404	application/json
errors.RequestValidationError	422	application/json
errors.APIError	4XX, 5XX	/

Example

from opperai import Opper, errors
import os


with Opper(
    http_bearer=os.getenv("OPPER_HTTP_BEARER", ""),
) as opper:
    res = None
    try:

        res = opper.call(name="add_numbers", instructions="Calculate the sum of two numbers", input_schema={
            "properties": {
                "x": {
                    "title": "X",
                    "type": "integer",
                },
                "y": {
                    "title": "Y",
                    "type": "integer",
                },
            },
            "required": [
                "x",
                "y",
            ],
            "title": "OpperInputExample",
            "type": "object",
        }, output_schema={
            "properties": {
                "sum": {
                    "title": "Sum",
                    "type": "integer",
                },
            },
            "required": [
                "sum",
            ],
            "title": "OpperOutputExample",
            "type": "object",
        }, input={
            "x": 4,
            "y": 5,
        }, examples=[
            {
                "input": {
                    "x": 1,
                    "y": 3,
                },
                "output": {
                    "sum": 4,
                },
                "comment": "Adds two numbers",
            },
        ], parent_span_id="123e4567-e89b-12d3-a456-426614174000", tags={
            "project": "project_456",
            "user": "company_123",
        }, configuration={})

        # Handle response
        print(res)

    except errors.BadRequestError as e:
        # handle e.data: errors.BadRequestErrorData
        raise(e)
    except errors.UnauthorizedError as e:
        # handle e.data: errors.UnauthorizedErrorData
        raise(e)
    except errors.NotFoundError as e:
        # handle e.data: errors.NotFoundErrorData
        raise(e)
    except errors.RequestValidationError as e:
        # handle e.data: errors.RequestValidationErrorData
        raise(e)
    except errors.APIError as e:
        # handle exception
        raise(e)

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 opperai import Opper
import httpx

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

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

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

Resource Management

The Opper class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from opperai import Opper
import os
def main():

    with Opper(
        http_bearer=os.getenv("OPPER_HTTP_BEARER", ""),
    ) as opper:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Opper(
        http_bearer=os.getenv("OPPER_HTTP_BEARER", ""),
    ) as opper:
        # Rest of application here...

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 opperai import Opper
import logging

logging.basicConfig(level=logging.DEBUG)
s = Opper(debug_logger=logging.getLogger("opperai"))

You can also enable a default debug logger by setting an environment variable OPPER_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 141 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
.vscode		.vscode
docs		docs
examples		examples
scripts		scripts
src/opperai		src/opperai
.gitattributes		.gitattributes
.gitignore		.gitignore
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
Makefile		Makefile
README.md		README.md
SPEAKEASY_PATCH_README.md		SPEAKEASY_PATCH_README.md
USAGE.md		USAGE.md
opper-python.mdc		opper-python.mdc
poetry.lock		poetry.lock
poetry.toml		poetry.toml
py.typed		py.typed
pylintrc		pylintrc
pyproject.toml		pyproject.toml
uv.lock		uv.lock

opper-ai/opper-python

Folders and files

Latest commit

History

Repository files navigation

opperai

Summary

Table of Contents

SDK Installation

PIP

Poetry / UV

SDK Example Usage

First steps

Example

Authentication

Available Resources and Operations

Server-sent event streaming

Retries

Error Handling

Example

Custom HTTP Client

Resource Management

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages