pydoc > openai

man perldoc info pydoc3 ri search

📦 NAME

openai – File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

🚀 Quick Reference

Use Case	Command	Description
🔑 Create a client	client = OpenAI()	Sync client, picks up OPENAI_API_KEY from env
⚡ Async client	client = AsyncOpenAI()	Async client, same env‑based auth
💬 Chat completion	client.chat.completions.create(...)	Send a prompt and get a model response
📊 Embeddings	client.embeddings.create(...)	Get vector representation of text
🖼️ Image generation	client.images.generate(...)	Generate images from a prompt
🎵 Audio transcription	client.audio.transcriptions.create(...)	Transcribe audio to text
📁 File upload	client.files.create(...)	Upload files for fine‑tuning or assistants
🏗️ Fine‑tuning	client.fine_tuning.jobs.create(...)	Create a fine‑tuning job
🛑 Moderation	client.moderations.create(...)	Check if content is harmful
🌀 Streaming	stream = client.chat.completions.create(..., stream=True)	Iterate over response chunks
📋 List models	client.models.list()	List available models
🔄 Copy client	client.copy(timeout=30)	Clone with overridden options
📦 Raw response	client.with_raw_response.chat...	Access the raw HTTP response
🌊 Streaming response	client.with_streaming_response.chat...	Get a streaming context manager

📁 PACKAGE CONTENTS

• _base_client
• _client
• _compat
• _constants
• _event_handler
• _exceptions
• _extras (package)
• _files
• _legacy_response
• _models
• _module_client
• _provider
• _qs
• _resource
• _response
• _send_queue
• _streaming
• _types
• _utils (package)
• _version
• auth (package)
• helpers (package)
• lib (package)
• pagination
• providers (package)
• resources (package)
• types (package)
• version

📂 SUBMODULES

• _azure
• _bedrock

🏛️ CLASSES

Exception Hierarchy

builtins.Exception
 └─ OpenAIError
     ├─ APIError
     │   ├─ APIConnectionError
     │   │   └─ APITimeoutError
     │   ├─ APIResponseValidationError
     │   └─ APIStatusError
     │       ├─ AuthenticationError
     │       │   └─ OAuthError
     │       ├─ BadRequestError
     │       ├─ ConflictError
     │       ├─ InternalServerError
     │       ├─ NotFoundError
     │       ├─ PermissionDeniedError
     │       ├─ RateLimitError
     │       └─ UnprocessableEntityError
     ├─ ContentFilterFinishReasonError
     ├─ LengthFinishReasonError
     ├─ WebSocketConnectionClosedError
     └─ WebSocketQueueFullError
builtins.ValueError
 └─ InvalidWebhookSignatureError

Client Classes

openai._base_client.AsyncAPIClient
 └─ AsyncOpenAI
     └─ AsyncBedrockOpenAI

openai._base_client.SyncAPIClient
 └─ OpenAI
     └─ BedrockOpenAI

Streaming & Helpers

typing.Generic
 ├─ AsyncStream
 └─ Stream
pydantic.main.BaseModel
 └─ BaseModel (openai)
builtins.dict
 ├─ ReconnectingOverrides
 └─ RequestOptions
builtins.object
 ├─ NotGiven
 ├─ Omit
 ├─ Timeout
 └─ ReconnectingEvent

OpenAI

openai.OpenAI – Synchronous OpenAI client.

Constructor: OpenAI(*, api_key, organization, project, base_url, timeout, max_retries, ...)
Automatically infers credentials from environment variables (OPENAI_API_KEY, OPENAI_ORG_ID, etc.).

Key properties: chat, completions, embeddings, files, images, audio, models, moderations, fine_tuning, batches, beta, realtime, responses, conversations, vector_stores, uploads, containers, skills, videos, webhooks, evals.

Methods: copy() – create a new client with overridden options; close() – close the underlying HTTP client; get(), post(), put(), patch(), delete() – low‑level HTTP methods; with_raw_response, with_streaming_response – access raw HTTP responses.

AsyncOpenAI

openai.AsyncOpenAI – Asynchronous OpenAI client.

Same interface as OpenAI but all methods are async. Constructor accepts an optional api_key: Callable[[], Awaitable[str]] for dynamic credentials.

Key properties: same as sync client.

Async methods: aenter(), aexit(), aclose(), adelete(), aget(), apost(), etc.

BaseModel

openai.BaseModel – Base pydantic model for all API objects.

Extends pydantic.BaseModel with extra = 'allow' and custom serialisation helpers.

Key methods: to_dict() – convert to dict (with use_api_names, exclude_unset); to_json() – JSON string; construct() – build without validation.

Stream / AsyncStream

Stream[_T] – Iterable over a synchronous server‑sent event stream.

AsyncStream[_T] – Async version.

Both provide __iter__/__aiter__, close(), and context manager support.

Exception Classes

• OpenAIError – base exception
• APIError – base for API errors (has request, body, code, param)
• APIStatusError – raised for 4xx/5xx responses; subclasses: AuthenticationError (401), BadRequestError (400), PermissionDeniedError (403), NotFoundError (404), ConflictError (409), UnprocessableEntityError (422), RateLimitError (429), InternalServerError (500)
• APIConnectionError – connection issues, APITimeoutError – timeout
• APIResponseValidationError – response validation failed
• OAuthError – auth error with OAuth details
• ContentFilterFinishReasonError – content filter triggered
• LengthFinishReasonError – max tokens reached
• WebSocketConnectionClosedError – WebSocket closed with unsent messages
• WebSocketQueueFullError – outgoing WebSocket queue full
• InvalidWebhookSignatureError – webhook signature mismatch

NotGiven / Omit

openai.NotGiven – sentinel to distinguish between “not passed” and “passed as None”.

openai.Omit – sentinel to explicitly omit a header or parameter (e.g., Content-Type).

Other Classes

• Timeout – configures connect, read, write, pool timeouts.
• RequestOptions – TypedDict for per‑request overrides (headers, extra_json, etc.).
• ReconnectingOverrides – TypedDict for reconnection customisation.
• ReconnectingEvent – dataclass with reconnection attempt info.
• BaseTransport – abstract transport; Transport alias.

🔧 FUNCTIONS

• file_from_path(path: str) -> FileTypes

📊 DATA

• DEFAULT_CONNECTION_LIMITS – Limits(max_connections=1000, ...)
• DEFAULT_MAX_RETRIES – 2
• DEFAULT_TIMEOUT – Timeout(connect=5.0, read=600, write=600, pool=600)
• NOT_GIVEN – sentinel
• not_given – alias for NOT_GIVEN
• omit – sentinel object
• __all__ – list of public symbols
• __title__ – 'openai'

🏷️ VERSION

2.44.0

📄 FILE

/home/chedong/.local/lib/python3.10/site-packages/openai/__init__.py

📦 NAME 🚀 Quick Reference 📁 PACKAGE CONTENTS 📂 SUBMODULES 🏛️ CLASSES 🔧 FUNCTIONS 📊 DATA 🏷️ VERSION 📄 FILE