docs: clarify AI request protocol handling - #13731
Open
kayx23 wants to merge 6 commits into
Open
Conversation
kayx23
requested review from
Baoyuantop,
Yilialinn,
juzhiyuan,
moonming and
shreemaan-abhishek
and removed request for
Baoyuantop and
shreemaan-abhishek
July 24, 2026 09:11
juzhiyuan
approved these changes
Jul 24, 2026
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.
Description
Several AI request formats share the same body fields: Bedrock Converse, Anthropic Messages, and OpenAI Chat Completions can contain
messages, while OpenAI Responses and Embeddings both useinput. APISIX resolves these overlaps by checking URI-specific formats before body-only formats, but the plugin documentation did not explain the detection order, required URI suffixes, or downstream endpoint selection consistently.The related AI plugins also handle the detected formats differently. Some inspect or modify each protocol's native content structure, while
ai-prompt-templatereplaces the complete request body andai-request-rewritecreates a separate provider request. The previous prompt-template description incorrectly limited templates to Chat Completions even though the plugin accepts any JSON template supported by the downstream plugin.This PR updates the English and Chinese plugin references to:
ai-proxyandai-proxy-multiai-prompt-templatereplaces the incoming body with an arbitrary rendered JSON templateapisix.apache.organd shows the resolved request and cited responseai-request-rewritecreates a separate non-streaming provider request instead of classifying and proxying the client's request as an AI protocolWhich issue(s) this PR fixes:
N/A
Validation
markdownlinton all changed pagesutils/fix-zh-doc-segment.pyandutils/check-category.pygit diff --checkChecklist