Module components 

This module defines shared data structures and components used across various OpenAI API groups. It includes common types for requests, responses, and specific components like chat, audio, and image-related structures.

Component Organization

Components are logically organized into the following groups:

Core Components

Foundation components used across all API endpoints:

• models - OpenAI model definitions
• common - Common types and utilities
• input - Common input handling
• output - Common output handling
• query - Query parameter handling

Endpoint Components

Chat & Completions

• chat_shared - Chat completion components
• completions_legacy - Legacy completions (deprecated)

Assistants

• assistants_shared - Assistant API components

Files & Storage

• files - File operations
• uploads - File uploads
• vector_stores_shared - Vector store management

Media Processing

• audio - Audio processing
• images - Image generation

Real-time Communication

• realtime_shared - Real-time API components

Batch Operations

• batch_shared - Batch operations
• fine_tuning_shared - Fine-tuning jobs

Content Processing

• moderations - Content moderation
• embeddings - Text embeddings

Administration

• administration_shared - Admin operations
• audit_logs_shared - Audit logging
• usage_shared - Usage tracking

Specialized Components

• responses - Response handling
• tools - Tool definitions

Modules

administration_shared

Structures shared across the Administration API endpoints (Users, Projects, Invites, API Keys, Rate Limits).

assistants_shared

Structures shared across the Assistants API, including Assistants, Threads, Messages, Runs, and Steps.

audio

Structures related to audio transcription and translation.

audit_logs_shared

Structures related to Audit Logs API endpoints.

batch_shared

Structures shared across the Batch API.

chat_shared

This module defines shared data structures and components used across various OpenAI chat-related API endpoints. It includes definitions for chat completion requests, messages, content parts, and tool-related structures.

common

Defines common data structures (components) used across various OpenAI API responses and requests. Based on the components/schemas section of the OpenAPI specification.

completions_legacy

Structures related to the legacy Completions API.

embeddings

Structures related to embeddings, representing vector representations of text.

embeddings_request

Request structures for embeddings API

exposed

Exposed namespace of the module.

files

Structures related to file objects used across the API.

fine_tuning_shared

Structures shared across the Fine-tuning API, including jobs, checkpoints, and events.

images

Structures related to image generation and manipulation responses.

input

Structures related to input content parts and messages.

models

Structures related to model information.

moderations

Structures related to content moderation results.

orphan

Orphan namespace of the module.

output

Structures related to output items generated by the model, such as messages, tool calls, and annotations.

own

Own namespace of the module.

prelude

Prelude to use essentials: use my_module ::prelude :: *.

query

Defines common query parameters used for listing resources (pagination, sorting).

realtime_shared

Structures shared across the Realtime API for session management and event handling.

responses

This module defines the data structures for requests and responses related to the OpenAI Responses API. It includes the main CreateResponseRequest for generating model responses, the ResponseObject object representing a generated response, and various stream event structures for real-time response generation.

tools

This module defines various tool-related structures used across the OpenAI API.

uploads

Structures related to the Uploads API for handling large file uploads in parts.

usage_shared

Structures related to API Usage and Costs endpoints.

vector_stores_shared

Structures related to Vector Stores, including files, batches, and search results.