Module openai 

Modules

config

Client configurations: OpenAIConfig for OpenAI, AzureConfig for Azure OpenAI Service.

error

Errors originating from API calls, parsing responses, and reading-or-writing to the file system.

traits

types

Types used in OpenAI API requests and responses. These types are created from component schemas in the OpenAPI spec

Structs

Assistants

Build assistants that can call models and use tools to perform tasks.

Audio

Turn audio into text or text into audio. Related guide: Speech to text

AuditLogs

Logs of user actions and configuration changes within this organization. To log events, you must activate logging in the Organization Settings. Once activated, for security reasons, logging cannot be deactivated.

Batches

Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount.

Chat

Given a list of messages comprising a conversation, the model will return a response.

Client

Client is a container for config, backoff and http_client used to make API calls.

Completions

Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. We recommend most users use our Chat completions API. Learn more

Embeddings

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.

Files

Files are used to upload documents that can be used with features like Assistants and Fine-tuning.

FineTuning

Manage fine-tuning jobs to tailor a model to your specific training data.

Images

Given a prompt and/or an input image, the model will generate a new image.

Invites

Invite and manage invitations for an organization. Invited users are automatically added to the Default project.

Messages

Represents a message within a thread.

Models

List and describe the various models available in the API. You can refer to the Models documentation to understand what models are available and the differences between them.

Moderations

Given text and/or image inputs, classifies if those inputs are potentially harmful across several categories.

ProjectAPIKeys

Manage API keys for a given project. Supports listing and deleting keys for users. This API does not allow issuing keys for users, as users need to authorize themselves to generate keys.

ProjectServiceAccounts

Manage service accounts within a project. A service account is a bot user that is not associated with a user. If a user leaves an organization, their keys and membership in projects will no longer work. Service accounts do not have this limitation. However, service accounts can also be deleted from a project.

ProjectUsers

Manage users within a project, including adding, updating roles, and removing users. Users cannot be removed from the Default project, unless they are being removed from the organization.

Projects

Manage the projects within an organization includes creation, updating, and archiving or projects. The Default project cannot be modified or archived.

Responses

Given text input or a list of context items, the model will generate a response.

Runs

Represents an execution run on a thread.

Steps

Represents a step in execution of a run.

Threads

Create threads that assistants can interact with.

Uploads

Allows you to upload large files in multiple parts.

Users

Manage users and their role in an organization. Users will be automatically added to the Default project.

VectorStoreFileBatches

Vector store file batches represent operations to add multiple files to a vector store.

VectorStoreFiles

Vector store files represent files inside a vector store.

VectorStores