Skip to content

Commit e949a91

Browse files
committed
docs(serve): fix double backticks
Signed-off-by: Mark Sturdevant <mark.sturdevant@ibm.com>
1 parent 6b3307d commit e949a91

2 files changed

Lines changed: 11 additions & 12 deletions

File tree

‎cli/serve/app.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -350,8 +350,8 @@ def _convert_response_input_to_messages(
350350
"""Convert Responses API input + instructions to a ChatMessage list.
351351
352352
Handles string shorthand, message arrays, and developer/system role
353-
mapping. The Responses API uses ``developer`` where Chat Completions uses
354-
``system``; both are mapped to ``system`` so existing backends receive a
353+
mapping. The Responses API uses `developer` where Chat Completions uses
354+
`system`; both are mapped to `system` so existing backends receive a
355355
role they understand.
356356
357357
Supports multimodal content: text, images (via image_url), and files
@@ -393,7 +393,7 @@ def _build_history_from_messages(
393393
"""Serialize a message list + assistant reply into a plain dict history.
394394
395395
The history is stored in a format that both the responses and chat/completions
396-
endpoints can consume: a list of ``{"role": str, "content": str}`` dicts,
396+
endpoints can consume: a list of `{"role": str, "content": str}` dicts,
397397
matching the ChatMessage wire format.
398398
"""
399399
history: list[dict[str, Any]] = [
@@ -409,11 +409,11 @@ def make_responses_endpoint(module):
409409
Mirrors make_chat_endpoint() with Responses API-specific adaptations:
410410
input conversion, semantic streaming, and Response output format.
411411
412-
Supports multi-turn sessions via ``previous_response_id``: when set, the
412+
Supports multi-turn sessions via `previous_response_id`: when set, the
413413
server looks up the stored history from that response and prepends it to
414414
the current input, so the client only needs to send the new turn.
415-
Completed responses are stored in the in-memory ``_response_store`` when
416-
``store=True`` (the default) and expire after ``_response_ttl_seconds``.
415+
Completed responses are stored in the in-memory `_response_store` when
416+
`store=True` (the default) and expire after `_response_ttl_seconds`.
417417
"""
418418
serve_sig = inspect.signature(module.serve)
419419
accepts_format = "format" in serve_sig.parameters
@@ -707,10 +707,10 @@ async def endpoint(request: ChatCompletionRequest):
707707
async def get_response(response_id: str) -> Response | JSONResponse:
708708
"""Retrieve a stored response by ID.
709709
710-
Returns the completed ``Response`` object that was stored when
711-
``store=True`` (the default) on the original ``POST /v1/responses``
712-
request. Returns 404 if the response has expired or was created with
713-
``store=False``. The ``expires_at`` field on the response indicates
710+
Returns the completed `Response` object that was stored when
711+
`store=True` (the default) on the original `POST /v1/responses`
712+
request. Returns 404 if the response has expired or was created with
713+
`store=False`. The `expires_at` field on the response indicates
714714
the exact Unix timestamp when the entry will be evicted.
715715
"""
716716
stored = _response_store.get(response_id)

‎cli/serve/streaming.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,7 @@ async def stream_response_chunks(
196196
- `response.in_progress` — signals streaming has started
197197
- `response.output_text.delta` — one per streamed token (or one for pre-computed)
198198
- `response.output_text.done` — full accumulated text
199-
- `response.output_item.added` — emitted when tool calls are present, before tool call events
200-
- `response.function_call_arguments.delta` — one per tool call argument payload
199+
- `response.function_call_arguments.delta` — one per tool call argument payload (if any)
201200
- `response.function_call_arguments.done` — one per tool call (if any)
202201
- `response.completed` — full `Response` object matching the non-streaming shape
203202

0 commit comments

Comments
 (0)