Implementation:Openai Openai python Types Package Exports
| Knowledge Sources | |
|---|---|
| Domains | API_Types |
| Last Updated | 2026-02-15 00:00 GMT |
Overview
Concrete tool for API type re-exports provided by the openai-python SDK.
Description
The types/__init__.py module serves as the centralized re-export hub for all Pydantic model types and parameter types used in API requests and responses. It imports over 110 type symbols covering response models (Batch, Image, Model, Completion, Embedding, Moderation, FileObject, Upload, VectorStore, Skill, Video, etc.), shared types (ChatModel, Reasoning, ErrorObject, CompoundFilter, FunctionDefinition, ResponseFormatJSONSchema, etc.), request parameter types (EvalCreateParams, FileCreateParams, BatchCreateParams, ImageGenerateParams, EmbeddingCreateParams, CompletionCreateParams, ModerationCreateParams, VectorStoreCreateParams, etc.), response types (ModerationCreateResponse, CreateEmbeddingResponse, ImagesResponse, ContainerCreateResponse, etc.), and supporting types (CompletionUsage, CompletionChoice, BatchRequestCounts, FileChunkingStrategy, StaticFileChunkingStrategy, WebsocketConnectionOptions, etc.). This file is auto-generated from the OpenAPI spec by Stainless.
Usage
Use this module to import any API type from a single flat namespace, e.g., from openai.types import Completion, ChatModel, ModerationCreateResponse.
Code Reference
Source Location
- Repository: openai-python
- File: src/openai/types/__init__.py
- Lines: 1-122
Signature
# Response models
from .batch import Batch
from .image import Image
from .model import Model
from .completion import Completion
from .embedding import Embedding
from .moderation import Moderation
from .file_object import FileObject
from .upload import Upload
from .vector_store import VectorStore
from .skill import Skill
from .video import Video
# Shared types
from .shared import ChatModel, Reasoning, ErrorObject, FunctionDefinition, ...
# Request parameter types
from .file_create_params import FileCreateParams
from .embedding_create_params import EmbeddingCreateParams
from .moderation_create_params import ModerationCreateParams
# ... and many more
# Response types
from .moderation_create_response import ModerationCreateResponse
from .create_embedding_response import CreateEmbeddingResponse
# ... and many more
Import
from openai.types import (
Batch,
Image,
Model,
Completion,
Embedding,
Moderation,
FileObject,
ChatModel,
ModerationCreateResponse,
CompletionCreateParams,
VectorStore,
)
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| N/A | N/A | N/A | This is a re-export module with no runtime inputs |
Outputs
| Name | Type | Description |
|---|---|---|
| Type classes | type (Pydantic BaseModel subclasses and TypedDicts) | Over 110 API type symbols for requests and responses |
Usage Examples
Basic Usage
from openai.types import Completion, ChatModel, FileObject
# Use types for type annotations
def process_completion(completion: Completion) -> str:
return completion.choices[0].text
# Use parameter types for request construction
from openai.types import ModerationCreateParams
params: ModerationCreateParams = {
"input": "Some text to moderate",
"model": "omni-moderation-latest",
}