Skip to content

Commit 2a62dba

Browse files
committed
fix(docs): standardize ai-prompt-template attribute table to 6-column format
Convert attribute table from 4-column to 6-column format (Name, Type, Required, Default, Valid values, Description) for consistency across plugin docs. Move role enum values to Valid values column.
1 parent 5a3f483 commit 2a62dba

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

docs/en/latest/plugins/ai-prompt-template.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ The `ai-prompt-template` Plugin supports pre-configuring prompt templates that o
4040

4141
## Plugin Attributes
4242

43-
| **Field** | **Required** | **Type** | **Description** |
44-
| --- | --- | --- | --- |
45-
| `templates` | True | array | An array of template objects. |
46-
| `templates.name` | True | string | Name of the template. When requesting the Route, the request should include the template name that corresponds to the configured template. |
47-
| `templates.template` | True | object | Template specification. |
48-
| `templates.template.model` | False | string | Name of the LLM model, such as `gpt-4` or `gpt-3.5`. See your LLM provider API documentation for more available models. |
49-
| `templates.template.messages` | False | array[object] | Template message specification. |
50-
| `templates.template.messages.role` | True | string | Role of the message. Valid values are `system`, `user`, and `assistant`. |
51-
| `templates.template.messages.content` | True | string | Content of the message (prompt). Use `{{variable_name}}` syntax to define template variables that will be filled from the request body. |
43+
| Name | Type | Required | Default | Valid values | Description |
44+
| --- | --- | --- | --- | --- | --- |
45+
| `templates` | array | True | | | An array of template objects. |
46+
| `templates.name` | string | True | | | Name of the template. When requesting the Route, the request should include the template name that corresponds to the configured template. |
47+
| `templates.template` | object | True | | | Template specification. |
48+
| `templates.template.model` | string | False | | | Name of the LLM model, such as `gpt-4` or `gpt-3.5`. See your LLM provider API documentation for more available models. |
49+
| `templates.template.messages` | array[object] | False | | | Template message specification. |
50+
| `templates.template.messages.role` | string | True | | [`system`, `user`, `assistant`] | Role of the message. |
51+
| `templates.template.messages.content` | string | True | | | Content of the message (prompt). Use `{{variable_name}}` syntax to define template variables that will be filled from the request body. |
5252

5353
## Examples
5454

docs/zh/latest/plugins/ai-prompt-template.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ import TabItem from '@theme/TabItem';
4040

4141
## 插件属性
4242

43-
| **字段** | **是否必填** | **类型** | **描述** |
44-
| --- | --- | --- | --- |
45-
| `templates` || array | 模板对象数组。 |
46-
| `templates.name` || string | 模板的名称。在请求路由时,请求中应包含与所配置模板相对应的模板名称。 |
47-
| `templates.template` || object | 模板规范。 |
48-
| `templates.template.model` || string | LLM 模型的名称,例如 `gpt-4``gpt-3.5`。更多可用模型请参阅 LLM 提供商的 API 文档。 |
49-
| `templates.template.messages` | | array[object] | 模板消息规范。 |
50-
| `templates.template.messages.role` | | string | 消息的角色。有效值为 `system``user``assistant`|
51-
| `templates.template.messages.content` || string | 消息(提示词)的内容。使用 `{{variable_name}}` 语法定义模板变量,这些变量将从请求体中填充。 |
43+
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
44+
| --- | --- | --- | --- | --- | --- |
45+
| `templates` | array | | | | 模板对象数组。 |
46+
| `templates.name` | string | | | | 模板的名称。在请求路由时,请求中应包含与所配置模板相对应的模板名称。 |
47+
| `templates.template` | object | | | | 模板规范。 |
48+
| `templates.template.model` | string | | | | LLM 模型的名称,例如 `gpt-4``gpt-3.5`。更多可用模型请参阅 LLM 提供商的 API 文档。 |
49+
| `templates.template.messages` | array[object] || | | 模板消息规范。 |
50+
| `templates.template.messages.role` | string | | | [`system`, `user`, `assistant`] | 消息的角色|
51+
| `templates.template.messages.content` | string | | | | 消息(提示词)的内容。使用 `{{variable_name}}` 语法定义模板变量,这些变量将从请求体中填充。 |
5252

5353
## 使用示例
5454

0 commit comments

Comments
 (0)