update plugin doc

CH3CHO · Sep 20, 2024 · 658ff3b · 658ff3b
1 parent 1f00387
commit 658ff3b
Show file tree

Hide file tree

Showing 4 changed files with 166 additions and 117 deletions.
diff --git a/backend/sdk/src/main/resources/plugins/ai-proxy/README.md b/backend/sdk/src/main/resources/plugins/ai-proxy/README.md
@@ -602,6 +602,51 @@ provider:
 }
 ```
 
+### 使用original协议代理百炼智能体应用
+**配置信息**
+
+```yaml
+provider:
+  type: qwen
+  apiTokens:
+    - "YOUR_DASHSCOPE_API_TOKEN"
+  protocol: original
+```
+
+**请求实例**
+```json
+{
+  "input": {
+      "prompt": "介绍一下Dubbo"
+  },
+  "parameters":  {},
+  "debug": {}
+}
+```
+
+**响应实例**
+
+```json
+{
+    "output": {
+        "finish_reason": "stop",
+        "session_id": "677e7e8fbb874e1b84792b65042e1599",
+        "text": "Apache Dubbo 是一个..."
+    },
+    "usage": {
+        "models": [
+            {
+                "output_tokens": 449,
+                "model_id": "qwen-max",
+                "input_tokens": 282
+            }
+        ]
+    },
+    "request_id": "b59e45e3-5af4-91df-b7c6-9d746fd3297c"
+}
+```
+
+
 ### 使用月之暗面配合其原生的文件上下文
 
 提前上传文件至月之暗面，以文件内容作为上下文使用其 AI 服务。
@@ -697,7 +742,7 @@ provider:
       "index": 0,
       "message": {
         "role": "assistant",
-        "content": "Ni Hao! (That's \"hello\" in Chinese!)\n\nI am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational manner. I'm not a human, but a computer program designed to simulate conversations and answer questions to the best of my ability. I'm happy to chat with you in Chinese or help with any questions or topics you'd like to discuss!"
+        "content": "😊 Ni Hao! (That's \"hello\" in Chinese!)\n\nI am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational manner. I'm not a human, but a computer program designed to simulate conversations and answer questions to the best of my ability. I'm happy to chat with you in Chinese or help with any questions or topics you'd like to discuss! 😊"
       },
       "logprobs": null,
       "finish_reason": "stop"

diff --git a/backend/sdk/src/main/resources/plugins/ai-proxy/README_EN.md b/backend/sdk/src/main/resources/plugins/ai-proxy/README_EN.md
@@ -688,7 +688,7 @@ provider:
       "index": 0,
       "message": {
         "role": "assistant",
-        "content": "Ni Hao! (That's \"hello\" in Chinese!)\n\nI am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational manner. I'm not a human, but a computer program designed to simulate conversations and answer questions to the best of my ability. I'm happy to chat with you in Chinese or help with any questions or topics you'd like to discuss!"
+        "content": "😊 Ni Hao! (That's \"hello\" in Chinese!)\n\nI am LLaMA, an AI assistant developed by Meta AI that can understand and respond to human input in a conversational manner. I'm not a human, but a computer program designed to simulate conversations and answer questions to the best of my ability. I'm happy to chat with you in Chinese or help with any questions or topics you'd like to discuss! 😊"
       },
       "logprobs": null,
       "finish_reason": "stop"

diff --git a/backend/sdk/src/main/resources/plugins/ext-auth/README.md b/backend/sdk/src/main/resources/plugins/ext-auth/README.md
@@ -35,13 +35,14 @@ description: Ext 认证插件实现了调用外部授权服务进行认证鉴权
 
 `endpoint`中每一项的配置字段说明
 
-| 名称       | 数据类型 | 必填 | 默认值 | 描述                                                                                      |
-| -------- | -------- | -- | ------ |-----------------------------------------------------------------------------------------|
-| `service_name` | string | 必填 | -                                                          | 输入授权服务名称，带服务类型的完整 FQDN 名称，例如 `ext-auth.dns` 、`ext-auth.my-ns.svc.cluster.local`         |
-| `service_port` | int    | 否 | 80 | 输入授权服务的服务端口                                                                             |
-| `path_prefix`    | string   | `endpoint_mode` 为`envoy`时必填        |        | `endpoint_mode` 为`envoy` 时，客户端向授权服务发送请求的请求路径前缀 |
-| `request_method` | string   | 否                                     | GET    | `endpoint_mode` 为`forward_auth` 时，客户端向授权服务发送请求的HTTP Method |
-| `path`           | string   | `endpoint_mode` 为`forward_auth`时必填 | -      | `endpoint_mode` 为`forward_auth` 时，客户端向授权服务发送请求的请求路径 |
+| 名称             | 数据类型 | 必填                                   | 默认值 | 描述                                                                                                   |
+| --------         | -------- | --                                     | ------ | -----------------------------------------------------------------------------------------              |
+| `service_name`   | string   | 必填                                   | -      | 输入授权服务名称，带服务类型的完整 FQDN 名称，例如 `ext-auth.dns` 、`ext-auth.my-ns.svc.cluster.local` |
+| `service_port`   | int      | 否                                     | 80     | 输入授权服务的服务端口                                                                                 |
+| `service_host`   | string   | 否                                     | -      | 请求授权服务时设置的Host头，不填时和FQDN保持一致                                                       |
+| `path_prefix`    | string   | `endpoint_mode` 为`envoy`时必填        |        | `endpoint_mode` 为`envoy` 时，客户端向授权服务发送请求的请求路径前缀                                   |
+| `request_method` | string   | 否                                     | GET    | `endpoint_mode` 为`forward_auth` 时，客户端向授权服务发送请求的HTTP Method                             |
+| `path`           | string   | `endpoint_mode` 为`forward_auth`时必填 | -      | `endpoint_mode` 为`forward_auth` 时，客户端向授权服务发送请求的请求路径                                |
 
 `authorization_request`中每一项的配置字段说明
 
@@ -108,7 +109,7 @@ curl -X POST http://localhost:8082/users?apikey=9a342114-ba8a-11ec-b1bf-00163e12
 
 ```
 POST /auth/users?apikey=9a342114-ba8a-11ec-b1bf-00163e1250b5 HTTP/1.1
-Host: ext-auth
+Host: ext-auth.backend.svc.cluster.local
 Authorization: xxx
 Content-Length: 0
 ```
@@ -147,9 +148,10 @@ http_service:
     allowed_upstream_headers:
     - exact: x-user-id
     - exact: x-auth-version
-  endpoint_mode: envoy  
+  endpoint_mode: envoy
   endpoint:
     service_name: ext-auth.backend.svc.cluster.local
+    service_host: my-domain.local
     service_port: 8090
     path_prefix: /auth
   timeout: 1000
@@ -165,7 +167,7 @@ curl -X POST http://localhost:8082/users?apikey=9a342114-ba8a-11ec-b1bf-00163e12
 
 ```
 POST /auth/users?apikey=9a342114-ba8a-11ec-b1bf-00163e1250b5 HTTP/1.1
-Host: ext-auth
+Host: my-domain.local
 Authorization: xxx
 X-Auth-Version: 1.0
 x-envoy-header: true
@@ -205,7 +207,7 @@ curl -i http://localhost:8082/users?apikey=9a342114-ba8a-11ec-b1bf-00163e1250b5
 
 ```
 POST /auth HTTP/1.1
-Host: ext-auth
+Host: ext-auth.backend.svc.cluster.local
 Authorization: xxx
 X-Original-Uri: /users?apikey=9a342114-ba8a-11ec-b1bf-00163e1250b5
 X-Original-Method: GET
@@ -246,9 +248,10 @@ http_service:
     allowed_upstream_headers:
     - exact: x-user-id
     - exact: x-auth-version
-  endpoint_mode: forward_auth  
+  endpoint_mode: forward_auth
   endpoint:
     service_name: ext-auth.backend.svc.cluster.local
+    service_host: my-domain.local
     service_port: 8090
     path: /auth
     request_method: POST
@@ -265,7 +268,7 @@ curl -i http://localhost:8082/users?apikey=9a342114-ba8a-11ec-b1bf-00163e1250b5
 
 ```
 POST /auth HTTP/1.1
-Host: ext-auth
+Host: my-domain.local
 Authorization: xxx
 X-Original-Uri: /users?apikey=9a342114-ba8a-11ec-b1bf-00163e1250b5
 X-Original-Method: GET