api_openai/components/
mod.rs

1//! This module defines shared data structures and components used across various
2//! `OpenAI` API groups. It includes common types for requests, responses,
3//! and specific components like chat, audio, and image-related structures.
4//!
5//! # Component Organization
6//!
7//! Components are logically organized into the following groups:
8//!
9//! ## Core Components
10//! Foundation components used across all API endpoints:
11//! - [`models`] - `OpenAI` model definitions
12//! - [`common`] - Common types and utilities
13//! - [`input`] - Common input handling
14//! - [`output`] - Common output handling
15//! - [`query`] - Query parameter handling
16//!
17//! ## Endpoint Components
18//!
19//! ### Chat & Completions
20//! - [`chat_shared`] - Chat completion components
21//! - [`completions_legacy`] - Legacy completions (deprecated)
22//!
23//! ### Assistants
24//! - [`assistants_shared`] - Assistant API components
25//!
26//! ### Files & Storage
27//! - [`files`] - File operations
28//! - [`uploads`] - File uploads
29//! - [`vector_stores_shared`] - Vector store management
30//!
31//! ### Media Processing
32//! - [`audio`] - Audio processing
33//! - [`images`] - Image generation
34//!
35//! ### Real-time Communication
36//! - [`realtime_shared`] - Real-time API components
37//!
38//! ### Batch Operations
39//! - [`batch_shared`] - Batch operations
40//! - [`fine_tuning_shared`] - Fine-tuning jobs
41//!
42//! ### Content Processing
43//! - [`moderations`] - Content moderation
44//! - [`embeddings`] - Text embeddings
45//!
46//! ### Administration
47//! - [`administration_shared`] - Admin operations
48//! - [`audit_logs_shared`] - Audit logging
49//! - [`usage_shared`] - Usage tracking
50//!
51//! ### Specialized Components
52//! - [`responses`] - Response handling
53//! - [`tools`] - Tool definitions
54
55mod private
56{
57}
58
59// === CORE COMPONENTS ===
60pub mod common;
61pub mod input;
62pub mod models;
63pub mod output;
64pub mod query;
65
66// === CHAT & COMPLETIONS ===
67pub mod chat_shared;
68pub mod completions_legacy;
69
70// === ASSISTANTS ===
71pub mod assistants_shared;
72
73// === FILES & STORAGE ===
74pub mod files;
75pub mod uploads;
76pub mod vector_stores_shared;
77
78// === MEDIA PROCESSING ===
79pub mod audio;
80pub mod images;
81
82// === REAL-TIME COMMUNICATION ===
83pub mod realtime_shared;
84
85// === BATCH OPERATIONS ===
86pub mod batch_shared;
87pub mod fine_tuning_shared;
88
89// === CONTENT PROCESSING ===
90pub mod embeddings;
91pub mod moderations;
92
93// === ADMINISTRATION ===
94pub mod administration_shared;
95pub mod audit_logs_shared;
96pub mod usage_shared;
97
98// === SPECIALIZED COMPONENTS ===
99pub mod responses;
100pub mod tools;
101pub mod embeddings_request;
102
103crate ::mod_interface!
104{
105  exposed use administration_shared;
106  exposed use assistants_shared;
107  exposed use audio;
108  exposed use audit_logs_shared;
109  exposed use batch_shared;
110  exposed use chat_shared;
111  exposed use common;
112  exposed use completions_legacy;
113  exposed use embeddings;
114  exposed use files;
115  exposed use fine_tuning_shared;
116  exposed use images;
117  exposed use input;
118  exposed use models;
119  exposed use moderations;
120  exposed use output;
121  exposed use query;
122  exposed use realtime_shared;
123  exposed use responses;
124  exposed use tools;
125  exposed use uploads;
126  exposed use usage_shared;
127  exposed use vector_stores_shared;
128  exposed use embeddings_request;
129}
api_openai/components/mod.rs

api_openai/components/
mod.rs
