log10py

🏗 Welcome to your new SDK! 🏗

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

SDK Installation

pip install git+<UNSET>.git

SDK Example Usage

Example

import log10

s = log10.Log10(
    log10_token="<YOUR_API_KEY_HERE>",
    x_log10_organization='<value>',
)


res = s.sessions.create(x_log10_organization='<value>')

if res.object is not None:
    # handle response
    pass

Available Resources and Operations

completions

• create - Create a completion
• update - Update completion by id.
• list_ungraded - List ungraded completions i.e. completions that have not been associated with feedback but matches task selector.

sessions

• create - Create a session

feedback

• get - Fetch feedback by id.
• list - List feedback
• upload - Upload a piece of feedback

feedback_tasks

• list - List feedback tasks.
• create - Create a new task.
• get - Retrieves feedback task taskId.

Global Parameters

A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set X-Log10-Organization to '<value>' at SDK initialization and then you do not have to pass the same value on calls to operations like update. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available. The required parameter must be set when you initialize the SDK client.

Name	Type	Required	Description
x_log10_organization	str	✔️	The x_log10_organization parameter.

Example

import log10
from log10.models import components

s = log10.Log10(
    log10_token="<YOUR_API_KEY_HERE>",
    x_log10_organization='<value>',
)


res = s.completions.update(completion_id='<value>', completion=components.Completion(
    organization_id='<value>',
    request=components.CreateChatCompletionRequest(
        messages=[
            components.ChatCompletionRequestFunctionMessage(
                role=components.ChatCompletionRequestFunctionMessageRole.FUNCTION,
                content='<value>',
                name='<value>',
            ),
        ],
        model=components.Two.GPT_4_TURBO,
        n=1,
        response_format=components.ResponseFormat(
            type=components.CreateChatCompletionRequestType.JSON_OBJECT,
        ),
        temperature=1,
        top_p=1,
        user='user-1234',
    ),
), x_log10_organization='<value>')

if res.completion 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 error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/

Example

import log10
from log10.models import components, errors

s = log10.Log10(
    log10_token="<YOUR_API_KEY_HERE>",
    x_log10_organization='<value>',
)

res = None
try:
    res = s.completions.create(completion=components.Completion(
    organization_id='<value>',
    request=components.CreateChatCompletionRequest(
        messages=[
            components.ChatCompletionRequestAssistantMessage(
                role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
            ),
        ],
        model=components.Two.GPT_4_TURBO,
        n=1,
        response_format=components.ResponseFormat(
            type=components.CreateChatCompletionRequestType.JSON_OBJECT,
        ),
        temperature=1,
        top_p=1,
        user='user-1234',
    ),
), x_log10_organization='<value>')

except errors.SDKError as e:
    # handle exception
    raise(e)

if res.any is not None:
    # handle response
    pass

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	https://log10.io	None

Example

import log10
from log10.models import components

s = log10.Log10(
    server_idx=0,
    log10_token="<YOUR_API_KEY_HERE>",
    x_log10_organization='<value>',
)


res = s.completions.create(completion=components.Completion(
    organization_id='<value>',
    request=components.CreateChatCompletionRequest(
        messages=[
            components.ChatCompletionRequestAssistantMessage(
                role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
            ),
        ],
        model=components.Two.GPT_4_TURBO,
        n=1,
        response_format=components.ResponseFormat(
            type=components.CreateChatCompletionRequestType.JSON_OBJECT,
        ),
        temperature=1,
        top_p=1,
        user='user-1234',
    ),
), x_log10_organization='<value>')

if res.any 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 log10
from log10.models import components

s = log10.Log10(
    server_url="https://log10.io",
    log10_token="<YOUR_API_KEY_HERE>",
    x_log10_organization='<value>',
)


res = s.completions.create(completion=components.Completion(
    organization_id='<value>',
    request=components.CreateChatCompletionRequest(
        messages=[
            components.ChatCompletionRequestAssistantMessage(
                role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
            ),
        ],
        model=components.Two.GPT_4_TURBO,
        n=1,
        response_format=components.ResponseFormat(
            type=components.CreateChatCompletionRequestType.JSON_OBJECT,
        ),
        temperature=1,
        top_p=1,
        user='user-1234',
    ),
), x_log10_organization='<value>')

if res.any is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the requests 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 a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import log10
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = log10.Log10(client=http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
log10_token	apiKey	API key

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

import log10
from log10.models import components

s = log10.Log10(
    log10_token="<YOUR_API_KEY_HERE>",
    x_log10_organization='<value>',
)


res = s.completions.create(completion=components.Completion(
    organization_id='<value>',
    request=components.CreateChatCompletionRequest(
        messages=[
            components.ChatCompletionRequestAssistantMessage(
                role=components.ChatCompletionRequestAssistantMessageRole.ASSISTANT,
            ),
        ],
        model=components.Two.GPT_4_TURBO,
        n=1,
        response_format=components.ResponseFormat(
            type=components.CreateChatCompletionRequestType.JSON_OBJECT,
        ),
        temperature=1,
        top_p=1,
        user='user-1234',
    ),
), x_log10_organization='<value>')

if res.any is not None:
    # handle response
    pass

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. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

log10py