0
# Known Issues - OpenAI Python Library Knowledge Tile
1

2
**Last Updated**: 2025-11-21
3
**Package**: openai@2.8.1
4
**Tile Version**: 2.8.1
5
**Status**: ✅ ALL ISSUES RESOLVED
6

7
## Summary
8

9
This document previously tracked systematic type pattern issues affecting approximately 432 parameter definitions across 25 documentation files. **All issues have been successfully resolved** as of 2025-11-21.
10

11
## Resolution Summary
12

13
### Issue: Type Pattern Inconsistency
14
**Status**: ✅ FIXED (2025-11-21)
15

16
All 432 instances of the incorrect pattern `Type | NotGiven = NOT_GIVEN` have been corrected to the proper pattern `Type | Omit = omit` across 19 documentation files.
17

18
### Automated Fix Applied
19

20
An automated script (`/job-run/fix_type_patterns.py`) was created and executed to systematically correct all type patterns while preserving special cases:
21
- ✅ Fixed 432 parameter type patterns
22
- ✅ Preserved `timeout` parameter using `NotGiven`/`not_given`
23
- ✅ Preserved `extra_*` parameters using `None` defaults
24

25
### Files Fixed (19 total)
26

27
| Document | Issues Fixed | Status |
28
|----------|-------------|--------|
29
| assistants.md | 25 | ✅ Fixed |
30
| audio.md | 17 | ✅ Fixed |
31
| batches.md | 4 | ✅ Fixed |
32
| chat-completions.md | 97 | ✅ Fixed |
33
| chatkit.md | 4 | ✅ Fixed |
34
| client-initialization.md | 1 | ✅ Fixed |
35
| completions.md | 16 | ✅ Fixed |
36
| embeddings.md | 3 | ✅ Fixed |
37
| files.md | 4 | ✅ Fixed |
38
| fine-tuning.md | 19 | ✅ Fixed |
39
| images.md | 31 | ✅ Fixed |
40
| index.md | 14 | ✅ Fixed |
41
| moderations.md | 1 | ✅ Fixed |
42
| realtime.md | 22 | ✅ Fixed |
43
| responses.md | 84 | ✅ Fixed |
44
| runs.md | 24 | ✅ Fixed |
45
| threads-messages.md | 22 | ✅ Fixed |
46
| vector-stores.md | 32 | ✅ Fixed |
47
| videos.md | 12 | ✅ Fixed |
48
| **TOTAL** | **432** | **100% Fixed** |
49
50
### Files With No Issues (6 total)
51

52
The following files had no type pattern issues from the start:
53
- containers.md
54
- conversations.md
55
- evals.md
56
- models.md
57
- uploads.md
58
- webhooks.md
59

60
## Validation Results
61

62
### API Completeness: ✅ 100% Coverage
63

64
Comprehensive validation confirmed complete coverage of all 23 major API areas with NO missing APIs or documentation gaps:
65

66
1. ✅ Chat Completions
67
2. ✅ Completions
68
3. ✅ Embeddings
69
4. ✅ Audio (transcriptions, translations, speech)
70
5. ✅ Images
71
6. ✅ Videos
72
7. ✅ Files
73
8. ✅ Uploads
74
9. ✅ Models
75
10. ✅ Fine-tuning
76
11. ✅ Moderations
77
12. ✅ Batches
78
13. ✅ Vector Stores
79
14. ✅ Assistants
80
15. ✅ Threads & Messages
81
16. ✅ Runs
82
17. ✅ ChatKit
83
18. ✅ Realtime API
84
19. ✅ Responses
85
20. ✅ Evaluations
86
21. ✅ Conversations
87
22. ✅ Containers
88
23. ✅ Webhooks
89

90
### Required Sections: ✅ All Present
91

92
All documentation files contain required sections:
93
- ✅ Entry-point doc has all required sections
94
- ✅ All sub-docs have Capabilities sections
95
- ✅ All API blocks marked with `{ .api }`
96
- ✅ Complete type definitions throughout
97
- ✅ Import statements showing how to access functionality
98
- ✅ Detailed parameter documentation
99
- ✅ Usage examples where appropriate
100

101
## Pattern Examples (After Fix)
102

103
### Example 1: Simple Optional Parameter ✅
104

105
**After Fix (Correct)**:
106
```python
107
def create(
108
    self,
109
    *,
110
    n: Optional[int] | Omit = omit,
111
) -> Response:
112
```
113

114
### Example 2: String Literal Parameter ✅
115

116
**After Fix (Correct)**:
117
```python
118
response_format: Optional[Literal["json", "text"]] | Omit = omit
119
```
120

121
### Example 3: Timeout Parameter (Special Case) ✅
122

123
**Correctly Preserved**:
124
```python
125
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN
126
```
127

128
### Example 4: Extra Parameters (Special Case) ✅
129

130
**Correctly Preserved**:
131
```python
132
extra_headers: dict[str, str] | None = None
133
extra_query: dict[str, object] | None = None
134
extra_body: dict[str, object] | None = None
135
```
136

137
## Historical Context
138

139
### Original Issue (Pre-2025-11-21)
140

141
The Knowledge Tile originally used an incorrect type pattern for optional parameters:
142
- **Incorrect**: `Type | NotGiven = NOT_GIVEN`
143
- **Correct**: `Type | Omit = omit`
144

145
This pattern inconsistency affected:
146
- Type safety expectations
147
- Developer experience with IDE autocomplete
148
- Consistency with the actual OpenAI SDK source code
149

150
### Why This Mattered
151

152
1. **Source Code Accuracy**: The OpenAI Python SDK uses `Omit`/`omit` for optional parameters
153
2. **Type Consistency**: Documentation should match actual API signatures
154
3. **Developer Experience**: Accurate types enable better IDE support and type checking
155
4. **Special Cases**: Only `timeout` uses `NotGiven`, and `extra_*` parameters use `None`
156

157
## Conclusion
158

159
**Status**: ✅ FULLY RESOLVED
160

161
This Knowledge Tile is now **complete and accurate** with:
162
- ✅ 432 type pattern fixes applied
163
- ✅ 100% API coverage validated
164
- ✅ All required sections present
165
- ✅ Type definitions consistent with source code
166
- ✅ No missing APIs or documentation gaps
167

168
The OpenAI Python library Knowledge Tile (v2.8.1) meets all requirements and best practices for Knowledge Tiles and accurately describes the package's complete public API surface.
169

170
---
171

172
*This file is retained for historical reference. All documented issues have been resolved.*
173