| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-plugin-center/ai/ai-proxy" data-has-hydrated="false"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v3.10.2"> |
| <title data-rh="true">AiProxy Plugin | Apache ShenYu</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://shenyu.apache.org/docs/plugin-center/ai/ai-proxy"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="zh"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="AiProxy Plugin | Apache ShenYu"><meta data-rh="true" name="description" content="AiProxy plugin"><meta data-rh="true" property="og:description" content="AiProxy plugin"><meta data-rh="true" name="keywords" content="AiProxy"><link data-rh="true" rel="icon" href="/img/favicon.svg"><link data-rh="true" rel="canonical" href="https://shenyu.apache.org/docs/plugin-center/ai/ai-proxy"><link data-rh="true" rel="alternate" href="https://shenyu.apache.org/docs/plugin-center/ai/ai-proxy" hreflang="en"><link data-rh="true" rel="alternate" href="https://shenyu.apache.org/zh/docs/plugin-center/ai/ai-proxy" hreflang="zh"><link data-rh="true" rel="alternate" href="https://shenyu.apache.org/docs/plugin-center/ai/ai-proxy" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"AiProxy Plugin","item":"https://shenyu.apache.org/docs/plugin-center/ai/ai-proxy"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache ShenYu RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache ShenYu Atom Feed"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="alternate" type="application/rss+xml" href="/news/rss.xml" title="Apache ShenYu RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/news/atom.xml" title="Apache ShenYu Atom Feed"> |
| |
| <script src="https://widget.kapa.ai/kapa-widget.bundle.js" async data-website-id="b6a69ccf-2d41-41cd-96dd-855ef71b46c7" data-project-name="Apache ShenYu" data-project-color="#FF5C00" data-project-logo="https://shenyu.apache.org/img/favicon.svg" data-language="en" data-color-scheme-selector="html[data-theme=dark]" data-modal-open-on-command-k="true" data-user-analytics-cookie-enabled="false" data-user-analytics-fingerprint-enabled="false" data-modal-title="Apache ShenYu Docs AI" data-launcher-button-text="Ask AI" data-ask-ai-input-placeholder="Ask a question about Apache ShenYu..." data-chat-disclaimer="Answers are generated by AI from the Apache ShenYu documentation and may be inaccurate. Please verify against the official docs." data-example-questions="How do I deploy ShenYu with Docker?,How do I configure the Divide plugin?,How do I use ShenYu with Spring Cloud?,How do I enable rate limiting?" data-launcher-button-background-color="#000033" data-launcher-button-hover-background-color="#1a1a4d" data-launcher-button-color="#ffffff" data-modal-header-background-color="#ffffff" data-modal-header-color="#000033" data-modal-header-background-color-dark="#17171a" data-modal-header-color-dark="#e4e4e7"></script> |
| <script src="/js/error-suppression.js"></script><link rel="stylesheet" href="/assets/css/styles.d41d8913.css"> |
| <script src="/assets/js/runtime~main.ab7ed176.js" defer="defer"></script> |
| <script src="/assets/js/main.a4e2a198.js" defer="defer"></script> |
| </head> |
| <body> |
| <svg style="display: none;"><defs> |
| <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol> |
| </defs></svg> |
| <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Apache ShenYu Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-light.svg" alt="Apache ShenYu Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/download">Download</a><a class="navbar__item navbar__link" href="/document">Docs</a><a class="navbar__item navbar__link" href="/community/contributor-guide">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/event">Event</a><a class="navbar__item navbar__link" href="/news">News</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/users">Users</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><a href="https://github.com/apache/shenyu" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/plugin-center/ai/ai-proxy" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh/docs/plugin-center/ai/ai-proxy" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">简体中文</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search searchBarContainer_NW3z" dir="ltr"><input placeholder="Search" aria-label="Search" class="navbar__search-input" value=""><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/"><span class="linkLabel_WmDU">Overview</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/design/database-design"><span class="categoryLinkLabel_W154">Design</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/deployment/deployment-before"><span class="categoryLinkLabel_W154">Deployment</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/quick-start/quick-start-dubbo"><span class="categoryLinkLabel_W154">Quick Start</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/user-guide/admin-usage/api-document"><span class="categoryLinkLabel_W154">User Guide</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/plugin-center/http-process/contextpath-plugin"><span class="categoryLinkLabel_W154">Plugin Center</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/http-process/contextpath-plugin"><span class="categoryLinkLabel_W154">Http Process</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/proxy/divide-plugin"><span class="categoryLinkLabel_W154">Proxy</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/fault-tolerance/hystrix-plugin"><span class="categoryLinkLabel_W154">Fault Tolerance</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/security/basic-auth-plugin"><span class="categoryLinkLabel_W154">Security</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/observability/logging-aliyun-sls"><span class="categoryLinkLabel_W154">Observability</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/common/general-context-plugin"><span class="categoryLinkLabel_W154">Common</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/cache/cache-plugin"><span class="categoryLinkLabel_W154">Cache</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/mock/mock-plugin"><span class="categoryLinkLabel_W154">Mock</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/docs/plugin-center/ai/ai-prompt"><span class="categoryLinkLabel_W154">Ai</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/ai/ai-prompt"><span class="linkLabel_WmDU">AiPrompt Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/plugin-center/ai/ai-proxy"><span class="linkLabel_WmDU">AiProxy Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/ai/ai-request-transformer"><span class="linkLabel_WmDU">AiRequestTransformer Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/ai/ai-response-transformer"><span class="linkLabel_WmDU">AiResponseTransformer Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/ai/ai-token-limiter"><span class="linkLabel_WmDU">AiTokenLimiter Plugin</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/mcp/mcp-server-plugin"><span class="categoryLinkLabel_W154">Mcp</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/developer/spi/custom-load-balance"><span class="categoryLinkLabel_W154">Developer</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/benchmark-test/"><span class="linkLabel_WmDU">Benchmark Test</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/help/security-model/"><span class="categoryLinkLabel_W154">Help</span></a></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Plugin Center</span></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Ai</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">AiProxy Plugin</span></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 2.7.1</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>AiProxy Plugin</h1></header><h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="description">Description<a href="#description" class="hash-link" aria-label="Direct link to Description" title="Direct link to Description" translate="no"></a></h2> |
| <p>The <strong>aiProxy</strong> plugin acts as a forwarding proxy for LLM requests, supporting major large-model services. Users send requests through ShenYu to a route configured with aiProxy; aiProxy then uses the plugin settings—such as provider (e.g., OpenAI, Alibaba Cloud), model name, API key, etc.—to call the corresponding LLM API and return the result. Typical use cases include forwarding chat requests to OpenAI’s ChatGPT endpoint or using domestic AI services for intelligent Q&A. Similar to previous plugin usage patterns, you can think of the LLM as taking on the role of your original application service. If you have a local model compatible with the OpenAI protocol or other mainstream protocols, you can also proxy it via the shenyu-aiProxy plugin.</p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="plugin-configuration">Plugin Configuration<a href="#plugin-configuration" class="hash-link" aria-label="Direct link to Plugin Configuration" title="Direct link to Plugin Configuration" translate="no"></a></h2> |
| <p>When configuring the plugin in the ShenYu admin interface, you first create a <strong>Selector</strong>, then create a <strong>Rule</strong>. A Selector is typically used to match request conditions (e.g., path, headers), while a Rule is used to configure plugin parameters or forwarding targets. For details on Selector and Rule configuration, see <a class="" href="/docs/user-guide/admin-usage/selector-and-rule">Selector and Rule Management</a>.</p> |
| <p>When using the aiProxy plugin, pay attention to the following fields:</p> |
| <ul> |
| <li class=""><strong>Selector</strong>: Defines the paths or request characteristics to match. For example, set <code>Pattern</code> to <code>/**</code> to match all requests, or specify a particular route path.</li> |
| <li class=""><strong>Rule</strong>: Specify plugin parameters at the rule level. Common fields include:<!-- --> |
| <ul> |
| <li class=""><code>provider</code>: The name of the provider, e.g., <code>OpenAI</code>.</li> |
| <li class=""><code>baseUrl</code>: The API endpoint for the LLM provider.</li> |
| <li class=""><code>model</code>: The model name.</li> |
| <li class=""><code>apiKey</code>: The authorization key.</li> |
| </ul> |
| </li> |
| </ul> |
| <p>Below are example screenshots of the aiProxy plugin configuration in the admin UI:</p> |
| <p>Selector matching the incoming path, followed by Rule settings for provider, model, API key, upstream address, etc.</p> |
| <p><img decoding="async" loading="lazy" src="/assets/images/ai-proxy-selector-en-230480625466a1dfa9c425afc223aaa1.png" width="2590" height="1096" class="img_ev3q"></p> |
| <p><img decoding="async" loading="lazy" src="/assets/images/ai-proxy-rule-en-2960454f8b38246d7730e40784ee795d.png" width="2581" height="1136" class="img_ev3q"></p> |
| <blockquote> |
| <p><strong>Note:</strong> With this setup, you also need to configure the <code>contextPath</code> plugin to remove the matched prefix and assemble the correct call URL. See <a class="" href="/docs/plugin-center/http-process/contextpath-plugin">contextPath Plugin Configuration</a> for details.</p> |
| </blockquote> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="api-usage">API Usage<a href="#api-usage" class="hash-link" aria-label="Direct link to API Usage" title="Direct link to API Usage" translate="no"></a></h2> |
| <p>After enabling the aiProxy plugin, you can send requests to the ShenYu gateway (e.g., via Postman) and obtain LLM responses through the proxy:</p> |
| <div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><div class="token-line" style="color:#393A34"><span class="token plain">curl --location --request POST 'http://localhost:9195/ai/proxy/v1/chat/completions' \</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> --header 'Content-Type: application/json' \</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> --data-raw '{</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> "model": "gpt-4o-mini",</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> "messages": [</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> "role": "system",</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> "content": "You are a translation assistant. Please translate the input content into English."</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> },</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> "role": "user",</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> "content": "I bloom amidst slaughter, like a flower at dawn."</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> ]</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }'</span><br></div></code></pre></div></div> |
| <p><img decoding="async" loading="lazy" src="/assets/images/ai-proxy-api-ef5e61fe03ccef55196fedd4b5e80797.png" width="1644" height="2242" class="img_ev3q"></p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="api-key-management">API Key Management<a href="#api-key-management" class="hash-link" aria-label="Direct link to API Key Management" title="Direct link to API Key Management" translate="no"></a></h2> |
| <p>The aiProxy plugin supports managing proxy API keys through the ShenYu Admin interface. Each proxy API key is scoped to a specific Selector and maps to a real upstream API key.</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="admin-endpoints">Admin Endpoints<a href="#admin-endpoints" class="hash-link" aria-label="Direct link to Admin Endpoints" title="Direct link to Admin Endpoints" translate="no"></a></h3> |
| <p>Base path: <code>/selector/{selectorId}/ai-proxy-apikey</code></p> |
| <table><thead><tr><th>Method</th><th>Path</th><th>Description</th><th>Permission</th></tr></thead><tbody><tr><td>POST</td><td><code>/selector/{selectorId}/ai-proxy-apikey</code></td><td>Create a proxy API key mapping</td><td><code>system:aiProxyApiKey:add</code></td></tr><tr><td>GET</td><td><code>/selector/{selectorId}/ai-proxy-apikey</code></td><td>List proxy API key mappings (paged)</td><td><code>system:aiProxyApiKey:list</code></td></tr><tr><td>PUT</td><td><code>/selector/{selectorId}/ai-proxy-apikey/{id}</code></td><td>Update a proxy API key mapping</td><td><code>system:aiProxyApiKey:edit</code></td></tr><tr><td>POST</td><td><code>/selector/{selectorId}/ai-proxy-apikey/batchDelete</code></td><td>Batch delete mappings</td><td><code>system:aiProxyApiKey:delete</code></td></tr><tr><td>POST</td><td><code>/selector/{selectorId}/ai-proxy-apikey/batchEnabled</code></td><td>Batch enable or disable mappings</td><td><code>system:aiProxyApiKey:disable</code></td></tr></tbody></table> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="query-parameters-get">Query Parameters (GET)<a href="#query-parameters-get" class="hash-link" aria-label="Direct link to Query Parameters (GET)" title="Direct link to Query Parameters (GET)" translate="no"></a></h3> |
| <table><thead><tr><th>Parameter</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><code>currentPage</code></td><td>Yes</td><td>Page number</td></tr><tr><td><code>pageSize</code></td><td>Yes</td><td>Page size</td></tr><tr><td><code>proxyApiKey</code></td><td>No</td><td>Filter by proxy API key value</td></tr></tbody></table> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="proxy-api-key-authentication">Proxy API Key Authentication<a href="#proxy-api-key-authentication" class="hash-link" aria-label="Direct link to Proxy API Key Authentication" title="Direct link to Proxy API Key Authentication" translate="no"></a></h2> |
| <p>When <code>proxyEnabled</code> is set to <code>true</code> in the Selector configuration, the plugin enforces API key authentication on all incoming requests.</p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="request-header">Request Header<a href="#request-header" class="hash-link" aria-label="Direct link to Request Header" title="Direct link to Request Header" translate="no"></a></h3> |
| <p>Clients must include the following header:</p> |
| <div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><div class="token-line" style="color:#393A34"><span class="token plain">X-API-KEY: <proxy-api-key></span><br></div></code></pre></div></div> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="authentication-behavior">Authentication Behavior<a href="#authentication-behavior" class="hash-link" aria-label="Direct link to Authentication Behavior" title="Direct link to Authentication Behavior" translate="no"></a></h3> |
| <table><thead><tr><th>Scenario</th><th>HTTP Status</th><th>Description</th></tr></thead><tbody><tr><td><code>X-API-KEY</code> header present and valid</td><td>200</td><td>Request forwarded; real upstream API key substituted transparently</td></tr><tr><td><code>X-API-KEY</code> header missing</td><td>401 Unauthorized</td><td>Request rejected</td></tr><tr><td><code>X-API-KEY</code> header present but invalid</td><td>401 Unauthorized</td><td>Request rejected</td></tr></tbody></table> |
| <blockquote> |
| <p><strong>Note:</strong> When proxy mode is enabled, the real upstream API key is never exposed to the client. The plugin resolves the mapping internally and substitutes the real key before forwarding the request to the LLM provider.</p> |
| </blockquote></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/apache/shenyu-website/edit/main/docs/plugin-center/ai/ai-proxy.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/plugin-center/ai/ai-prompt"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">AiPrompt Plugin</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/plugin-center/ai/ai-request-transformer"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">AiRequestTransformer Plugin</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#description" class="table-of-contents__link toc-highlight">Description</a></li><li><a href="#plugin-configuration" class="table-of-contents__link toc-highlight">Plugin Configuration</a></li><li><a href="#api-usage" class="table-of-contents__link toc-highlight">API Usage</a></li><li><a href="#api-key-management" class="table-of-contents__link toc-highlight">API Key Management</a><ul><li><a href="#admin-endpoints" class="table-of-contents__link toc-highlight">Admin Endpoints</a></li><li><a href="#query-parameters-get" class="table-of-contents__link toc-highlight">Query Parameters (GET)</a></li></ul></li><li><a href="#proxy-api-key-authentication" class="table-of-contents__link toc-highlight">Proxy API Key Authentication</a><ul><li><a href="#request-header" class="table-of-contents__link toc-highlight">Request Header</a></li><li><a href="#authentication-behavior" class="table-of-contents__link toc-highlight">Authentication Behavior</a></li></ul></li></ul></div></div></div></div></main></div></div></div></div> |
| </body> |
| </html> |