This is an automated email from the ASF dual-hosted git repository.
traky pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new d212a81c0 docs(ai-proxy-multi): move override.endpoint from logging to
instances (#13199)
d212a81c0 is described below
commit d212a81c065ccedfa88a0944c4de41ec30dadcea
Author: Mohammad Izzraff Janius
<[email protected]>
AuthorDate: Fri Apr 10 17:51:18 2026 +0800
docs(ai-proxy-multi): move override.endpoint from logging to instances
(#13199)
* docs(ai-proxy-multi): move override.endpoint from logging to instances
* add missing param from healthcheck
* use precise wording
---
docs/en/latest/plugins/ai-proxy-multi.md | 15 +++++++++++++--
docs/zh/latest/plugins/ai-proxy-multi.md | 15 +++++++++++++--
2 files changed, 26 insertions(+), 4 deletions(-)
diff --git a/docs/en/latest/plugins/ai-proxy-multi.md
b/docs/en/latest/plugins/ai-proxy-multi.md
index 295acca84..dedde607c 100644
--- a/docs/en/latest/plugins/ai-proxy-multi.md
+++ b/docs/en/latest/plugins/ai-proxy-multi.md
@@ -73,11 +73,11 @@ In addition, the Plugin also supports logging LLM request
information in the acc
| instances.auth.gcp.expire_early_secs| integer | False | 60
| minimum = 0 | Seconds to expire the access token
before its actual expiration time to avoid edge cases. |
| instances.options | object | False |
| | Model configurations. In addition to
`model`, you can configure additional parameters and they will be forwarded to
the upstream LLM service in the request body. For instance, if you are working
with OpenAI, DeepSeek, or AIMLAPI, you can configure additional parameters such
as `max_tokens`, `temperature`, `top_p`, and `stream`. See your LLM provider's
API documentation f [...]
| instances.options.model | string | False |
| | Name of the LLM model, such as `gpt-4`
or `gpt-3.5`. See your LLM provider's API documentation for more available
models. |
+| instances.override | object | False |
| | Override setting. |
+| instances.override.endpoint | string | False |
| | LLM provider endpoint to replace the
default endpoint with. If not configured, the Plugin uses the default OpenAI
endpoint `https://api.openai.com/v1/chat/completions`. |
| logging | object | False |
| | Logging configurations. Does not affect
`error.log`. |
| logging.summaries | boolean | False | false
| | If true, logs request LLM model,
duration, request, and response tokens. |
| logging.payloads | boolean | False | false
| | If true, logs request and response
payload. |
-| logging.override | object | False |
| | Override setting. |
-| logging.override.endpoint | string | False |
| | LLM provider endpoint to replace the
default endpoint with. If not configured, the Plugin uses the default OpenAI
endpoint `https://api.openai.com/v1/chat/completions`. |
| checks | object | False |
| | Health check configurations. Note that
at the moment, OpenAI, DeepSeek, and AIMLAPI do not provide an official health
check endpoint. Other LLM services that you can configure under
`openai-compatible` provider may have available health check endpoints. |
| checks.active | object | True |
| | Active health check configurations. |
| checks.active.type | string | False | http
| [http, https, tcp] | Type of health check connection. |
@@ -87,6 +87,17 @@ In addition, the Plugin also supports logging LLM request
information in the acc
| checks.active.port | integer | False |
| between 1 and 65535 inclusive | HTTP port. |
| checks.active.http_path | string | False | /
| | Path for HTTP probing requests. |
| checks.active.https_verify_certificate | boolean | False | true
| | If true, verify the node's TLS certificate.
|
+| checks.active.req_headers | array[string] | False |
| | Additional request headers for the
active health check probe. |
+| checks.active.healthy | object | False |
| | Healthy check configurations. |
+| checks.active.healthy.interval | integer | False | 1
| minimum = 1 | Time interval of checking healthy nodes,
in seconds. |
+| checks.active.healthy.http_statuses | array[integer] | False | [200, 302]
| between 200 and 599 | HTTP status codes defining a
healthy node. |
+| checks.active.healthy.successes | integer | False | 2
| between 1 and 254 | Number of successful probes to
define a healthy node. |
+| checks.active.unhealthy | object | False |
| | Unhealthy check configurations. |
+| checks.active.unhealthy.interval | integer | False | 1
| minimum = 1 | Time interval of checking unhealthy
nodes, in seconds. |
+| checks.active.unhealthy.http_statuses | array[integer] | False | [429, 404,
500, 501, 502, 503, 504, 505] | between 200 and 599 | HTTP status codes
defining an unhealthy node. |
+| checks.active.unhealthy.http_failures | integer | False | 5
| between 1 and 254 | Number of HTTP failures to define an
unhealthy node. |
+| checks.active.unhealthy.tcp_failures | integer | False | 2
| between 1 and 254 | Number of TCP failures to define an
unhealthy node. |
+| checks.active.unhealthy.timeouts | integer | False | 3
| between 1 and 254 | Number of probe timeouts to define
an unhealthy node. |
| timeout | integer | False | 30000
| greater than or equal to 1 | Request timeout in
milliseconds when requesting the LLM service. |
| keepalive | boolean | False | true
| | If true, keep the connection alive when
requesting the LLM service. |
| keepalive_timeout | integer | False | 60000
| greater than or equal to 1000 | Request timeout in
milliseconds when requesting the LLM service. |
diff --git a/docs/zh/latest/plugins/ai-proxy-multi.md
b/docs/zh/latest/plugins/ai-proxy-multi.md
index c1ca7f8c7..9cc22ed43 100644
--- a/docs/zh/latest/plugins/ai-proxy-multi.md
+++ b/docs/zh/latest/plugins/ai-proxy-multi.md
@@ -73,11 +73,11 @@ description: ai-proxy-multi 插件通过负载均衡、重试、故障转移和
| instances.auth.gcp.expire_early_secs| integer | 否 | 60
| minimum = 0 | 在访问令牌实际过期时间之前使其过期的秒数，以避免边缘情况。 |
| instances.options | object | 否 |
| | 模型配置。除了 `model` 之外，您还可以配置其他参数，它们将在请求体中转发到上游
LLM 服务。例如，如果您使用 OpenAI、DeepSeek 或 AIMLAPI，可以配置其他参数，如
`max_tokens`、`temperature`、`top_p` 和 `stream`。有关更多可用选项，请参阅您的 LLM 提供商的 API 文档。 |
| instances.options.model | string | 否 |
| | LLM 模型的名称，如 `gpt-4` 或
`gpt-3.5`。有关更多可用模型，请参阅您的 LLM 提供商的 API 文档。 |
+| instances.override | object | 否 |
| | 覆盖设置。 |
+| instances.override.endpoint | string | 否 |
| | 用于替换默认端点的 LLM 提供商端点。如果未配置，插件使用默认的 OpenAI 端点
`https://api.openai.com/v1/chat/completions`。 |
| logging | object | 否 |
| | 日志配置。不影响 `error.log`。 |
| logging.summaries | boolean | 否 | false
| | 如果为 true，记录请求 LLM 模型、持续时间、请求和响应令牌。 |
| logging.payloads | boolean | 否 | false
| | 如果为 true，记录请求和响应负载。 |
-| logging.override | object | 否 |
| | 覆盖设置。 |
-| logging.override.endpoint | string | 否 |
| | 用于替换默认端点的 LLM 提供商端点。如果未配置，插件使用默认的 OpenAI 端点
`https://api.openai.com/v1/chat/completions`。 |
| checks | object | 否 |
| | 健康检查配置。请注意，目前 OpenAI、DeepSeek 和 AIMLAPI
不提供官方健康检查端点。您可以在 `openai-compatible` 提供商下配置的其他 LLM 服务可能有可用的健康检查端点。 |
| checks.active | object | 是 |
| | 主动健康检查配置。 |
| checks.active.type | string | 否 | http
| [http, https, tcp] | 健康检查连接类型。 |
@@ -87,6 +87,17 @@ description: ai-proxy-multi 插件通过负载均衡、重试、故障转移和
| checks.active.port | integer | 否 |
| 1 到 65535（包含） | HTTP 端口。 |
| checks.active.http_path | string | 否 | /
| | HTTP 探测请求的路径。 |
| checks.active.https_verify_certificate | boolean | 否 | true
| | 如果为 true，验证节点的 TLS 证书。 |
+| checks.active.req_headers | array[string] | 否 |
| | 主动健康检查探测的附加请求标头。 |
+| checks.active.healthy | object | 否 |
| | 健康检查配置。 |
+| checks.active.healthy.interval | integer | 否 | 1
| minimum = 1 | 检查健康节点的时间间隔（秒）。 |
+| checks.active.healthy.http_statuses | array[integer] | 否 | [200, 302]
| 200 到 599 | 定义健康节点的 HTTP 状态码。 |
+| checks.active.healthy.successes | integer | 否 | 2
| 1 到 254 | 定义健康节点所需的成功探测次数。 |
+| checks.active.unhealthy | object | 否 |
| | 不健康检查配置。 |
+| checks.active.unhealthy.interval | integer | 否 | 1
| minimum = 1 | 检查不健康节点的时间间隔（秒）。 |
+| checks.active.unhealthy.http_statuses | array[integer] | 否 | [429, 404,
500, 501, 502, 503, 504, 505] | 200 到 599 | 定义不健康节点的 HTTP 状态码。 |
+| checks.active.unhealthy.http_failures | integer | 否 | 5
| 1 到 254 | 定义不健康节点所需的 HTTP 失败次数。 |
+| checks.active.unhealthy.tcp_failures | integer | 否 | 2
| 1 到 254 | 定义不健康节点所需的 TCP 失败次数。 |
+| checks.active.unhealthy.timeouts | integer | 否 | 3
| 1 到 254 | 定义不健康节点所需的探测超时次数。 |
| timeout | integer | 否 | 30000
| 大于或等于 1 | 请求 LLM 服务时的请求超时时间（毫秒）。 |
| keepalive | boolean | 否 | true
| | 如果为 true，在请求 LLM 服务时保持连接活跃。 |
| keepalive_timeout | integer | 否 | 60000
| 大于或等于 1000 | 请求 LLM 服务时的请求超时时间（毫秒）。 |
