Commit 370337b
authored
fix(inference): return requested model id in streamed completion chunks (#6320)
# What does this PR do?
Re-opens #6314 (previously closed). @mattf confirmed this as a real bug
and asked to continue it — reopening with the same fix.
Fixes an inconsistency in `InferenceRouter.openai_completion`: streamed
`/v1/completions` chunks report the provider-internal model id instead
of the model id the client requested.
The router rewrites `params.model` to the provider's
`provider_resource_id` before calling the provider. For non-streaming
requests it then restores the requested fully qualified id
(`response.model = request_model_id`), and the chat-completions
streaming path does the same per chunk in
`stream_tokens_and_compute_metrics_openai_chat` (`chunk.model =
fully_qualified_model_id`). But the `stream=True` branch of
`openai_completion` returned the provider stream untouched, so every
streamed chunk leaked the provider-internal id — e.g. a client
requesting `openai/gpt-4o` gets `model="openai/gpt-4o"` when not
streaming but `model="gpt-4o"` on every streamed chunk. Clients that
correlate responses by the model they requested (or that multiplex
providers behind aliases) see different model ids depending solely on
whether they streamed.
The fix wraps the provider stream in a small async generator that
restores the requested model id on each chunk before yielding, mirroring
the existing chat-streaming behavior — including skipping `None` chunks,
exactly as `stream_tokens_and_compute_metrics_openai_chat` does.
Provider exceptions and stream termination propagate through unchanged.
The return type annotation is also corrected to `OpenAICompletion |
AsyncIterator[OpenAICompletion]`, matching both the chat sibling and the
`Inference` API definition in `src/ogx_api/inference/api.py`.
## Test Plan
Added unit tests in `tests/unit/core/routers/test_inference_router.py`:
- `test_openai_completion_streaming_rewrites_model_id` — the core case
(requested fully qualified id differs from the provider's internal id,
multi-chunk); fails on `main`, passes with this fix
- `test_openai_completion_streaming_empty_stream` — a provider stream
yielding zero chunks produces an empty stream without errors
- `test_openai_completion_streaming_model_id_already_correct` — chunks
already carrying the requested id pass through unchanged
- `test_openai_completion_streaming_skips_none_chunks` — `None` chunks
are skipped, matching the chat streaming path; fails on `main`
- `test_openai_completion_streaming_propagates_provider_errors` — a
mid-stream provider error propagates to the caller after earlier chunks
are delivered
- `test_openai_completion_non_streaming_rewrites_model_id` — regression
guard for the already-correct non-streaming path
```
$ uv run pytest tests/unit/core/routers/ -q
87 passed, 1 warning in 1.21s
```
`uv run pre-commit run --files ...` passes on both touched files (ruff,
ruff format, mypy, and all repo-local hooks).
---------
Signed-off-by: Sohum Trivedi <trivsohum@gmail.com>1 parent 405dba9 commit 370337b
2 files changed
Lines changed: 208 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
189 | 189 | | |
190 | 190 | | |
191 | 191 | | |
192 | | - | |
| 192 | + | |
193 | 193 | | |
194 | 194 | | |
195 | 195 | | |
| |||
204 | 204 | | |
205 | 205 | | |
206 | 206 | | |
207 | | - | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
208 | 212 | | |
209 | 213 | | |
210 | 214 | | |
211 | 215 | | |
212 | 216 | | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
213 | 230 | | |
214 | 231 | | |
215 | 232 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
| 26 | + | |
| 27 | + | |
26 | 28 | | |
27 | 29 | | |
28 | 30 | | |
29 | 31 | | |
30 | 32 | | |
| 33 | + | |
31 | 34 | | |
32 | 35 | | |
33 | 36 | | |
| |||
49 | 52 | | |
50 | 53 | | |
51 | 54 | | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
52 | 241 | | |
53 | 242 | | |
54 | 243 | | |
| |||
0 commit comments