Skip to content

[Doc] Show how to get Responses prompt token IDs - #55912

Merged
DarkLight1337 merged 3 commits into
vllm-project:mainfrom
franciscojavierarceo:responses-tokenize
Sep 16, 2026
Merged

DarkLight1337 merged 3 commits into
vllm-project:mainfrom
franciscojavierarceo:responses-tokenize

Conversation

@franciscojavierarceo

@franciscojavierarceo franciscojavierarceo commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

Purpose

frontends can already get Responses prompt token IDs from /v1/responses/render, added in #50195. this documents how to use it before choosing a model replica: enable the endpoint, send the full request, and extract token IDs or their count with jq.

it expands the renderer overview to explain its preprocessing capabilities and links the example from the Responses API docs, where it clarifies that a separate /tokenize call is not needed. the guide covers API-key authentication, matching renderer configuration, stateless history, and retaining multimodal payloads for generation.

follow-up to #40556. #50195 provides the implementation; this adds the token-inspection workflow. duplicate checks on September 8 found no other open PR documenting this workflow.

Validation

  • pre-commit passed:

    .venv/bin/python -m pre_commit run --files \
      docs/serving/online_serving/README.md \
      docs/serving/online_serving/renderer.md \
      docs/serving/online_serving/openai_compatible_server.md
  • both Bash examples pass bash -n; the example JSON validates as a ResponsesRequest.

  • both jq filters return the expected IDs/count on a sample payload; the added links point to existing headings.

  • git diff --check passed.

only documentation changes. no model evaluation is needed. the live example remains unverified on this macOS host because vLLM cannot infer a supported device; a full docs build was not run locally.

AI assistance: OpenAI Codex helped edit and check the documentation.

@mergify

mergify Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Documentation preview: https://vllm--55912.org.readthedocs.build/en/55912/

@mergify mergify Bot added documentation Improvements or additions to documentation frontend labels Sep 8, 2026
Document using the existing Responses render endpoint to inspect prompt
IDs before routing, with server setup, a curl/jq example, authentication,
and a link from the tokenization guide.

Co-authored-by: OpenAI Codex <codex@openai.com>
Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
@franciscojavierarceo franciscojavierarceo changed the title [Frontend] Support Responses input in /tokenize [Doc] Show how to get Responses prompt token IDs Sep 8, 2026
@franciscojavierarceo
franciscojavierarceo marked this pull request as ready for review September 8, 2026 19:44

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

Comment thread docs/serving/online_serving/README.md Outdated
Describe general preprocessing capabilities in the renderer overview and
place the Responses tokenization guidance in the Responses API section.

Co-authored-by: OpenAI Codex <codex@openai.com>
Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
@DarkLight1337
DarkLight1337 enabled auto-merge (squash) September 14, 2026 17:59
@github-actions github-actions Bot added the ready ONLY add when PR is ready to merge/full CI is needed label Sep 14, 2026

@chaunceyjiang chaunceyjiang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks~

@chaunceyjiang

Copy link
Copy Markdown
Contributor

/ci run

@github-actions

Copy link
Copy Markdown

✅ Triggered Buildkite CI #89229 for commit 2bce44d02229.

@DarkLight1337
DarkLight1337 merged commit 7d4bba5 into vllm-project:main Sep 16, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build-docs documentation Improvements or additions to documentation frontend ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants