docs(ai-rag): re-port with Admin API, ADC, and Ingress Controller tabs#13208
Open
Yilialinn wants to merge 4 commits intoapache:masterfrom
Open
docs(ai-rag): re-port with Admin API, ADC, and Ingress Controller tabs#13208Yilialinn wants to merge 4 commits intoapache:masterfrom
Yilialinn wants to merge 4 commits intoapache:masterfrom
Conversation
dosubot
bot
added
size:L
There was a problem hiding this comment.
Pull request overview
Re-ports the ai-rag plugin documentation (EN + ZH) to include multi-tab configuration examples (Admin API, ADC, and Ingress Controller), aligning with the API7 docs format and adding nested sub-tabs for Gateway API vs APISIX Ingress Controller under the Ingress Controller section.
Changes:
- Added Docusaurus Tabs/TabItem-based config walkthroughs for Admin API, ADC, and Kubernetes ingress scenarios.
- Refreshed plugin attribute/request-body tables and expanded parameter notes (e.g., Azure AI Search vector query parameters).
- Updated both English and Chinese docs, including example payload trimming.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 15 comments.
| File | Description |
|---|---|
| docs/en/latest/plugins/ai-rag.md | Adds Admin API/ADC/Ingress Controller tabbed examples and updates tables/wording for the EN ai-rag doc. |
| docs/zh/latest/plugins/ai-rag.md | Mirrors the EN doc structure in ZH and introduces tabbed examples plus table rewrites. |
Comments suppressed due to low confidence (1)
docs/zh/latest/plugins/ai-rag.md:120
- 示例环境变量块里包含看起来像真实的 Azure OpenAI / Azure AI Search API key（长随机字符串）。公开文档建议统一改为明显占位符（如
<your-api-key>/<your-search-api-key>），避免凭据泄露或读者误用。
# 替换为你的值
AZ_OPENAI_DOMAIN=https://ai-plugin-developer.openai.azure.com
AZ_OPENAI_API_KEY=9m7VYroxITMDEqKKEnpOknn1rV7QNQT7DrIBApcwMLYJQQJ99ALACYeBjFXJ3w3AAABACOGXGcd
AZ_CHAT_ENDPOINT=${AZ_OPENAI_DOMAIN}/openai/deployments/gpt-4o/chat/completions?api-version=2024-02-15-preview
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Convert attribute table from 4-column to 6-column format (Name, Type, Required, Default, Valid values, Description) for consistency across plugin docs.
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.
Summary
ai-ragplugin documentation from API7 docs with all three configuration tabs (Admin API, ADC, Ingress Controller)