Add no_inline_citations support to Responses API include option (xai)#13201
Open
jdiogoc wants to merge 1 commit intovercel:mainfrom
Open
Add no_inline_citations support to Responses API include option (xai)#13201jdiogoc wants to merge 1 commit intovercel:mainfrom
jdiogoc wants to merge 1 commit intovercel:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
The xAI Responses API supports "no_inline_citations" in the include field to disable inline citation markdown ([N]) from being inserted into response text. This is documented by xAI, but the AI SDK's @ai-sdk/xai provider doesn't currently allow passing this value, the include option only accepts 'file_search_call.results'.
Summary
Added 'no_inline_citations' as a valid value for the include provider option in the Responses API. This lets users disable inline citations when using xai.responses() with server-side search tools like web_search and x_search.
Two changes:
Manual Verification
Tested against the xAI Responses API with web_search enabled. Without this change, the response text contains inline citation markdown like [1]. With include: ['no_inline_citations'], the response text is returned without citation markdown, matching the behavior described in xAI's documentation.
Checklist
pnpm changesetin the project root)Future Work
The Chat API has a separate searchParameters.returnCitations option that controls citations for Live Search. It may be worth documenting the distinction between the two approaches (Chat API vs Responses API) more clearly.
Related Issues