Skip to content

Commit 188d854

Browse files
authored
docs(installation): Add parameter description for ai.backend (#597)
Update 2-installation.md
1 parent b41fd68 commit 188d854

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

karpor_versioned_docs/version-v0.6/1-getting-started/2-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,11 @@ The Karpor Server Component is main backend server. It itself is an `apiserver`,
147147
|-----|------|---------|-------------|
148148
| server.ai | object | `{"authToken":"","backend":"openai","baseUrl":"","model":"gpt-3.5-turbo","temperature":1,"topP":1}` | AI configuration section. The AI analysis feature requires that [authToken, baseUrl] be assigned values. |
149149
| server.ai.authToken | string | `""` | Authentication token for accessing the AI service. |
150-
| server.ai.backend | string | `"openai"` | Backend service or platform that the AI model is hosted on. e.g., "openai". If the backend you are using is compatible with OpenAI, then there is no need to make any changes here. |
150+
| server.ai.backend | string | `"openai"` | Backend service or platform that the AI model is hosted on. Available options:<br/>- `"openai"`: OpenAI API (default)<br/>- `"azureopenai"`: Azure OpenAI Service<br/>- `"huggingface"`: Hugging Face API<br/>If the backend you are using is compatible with OpenAI, then there is no need to make any changes here. |
151151
| server.ai.baseUrl | string | `""` | Base URL of the AI service. e.g., "https://api.openai.com/v1". |
152152
| server.ai.model | string | `"gpt-3.5-turbo"` | Name or identifier of the AI model to be used. e.g., "gpt-3.5-turbo". |
153153
| server.ai.temperature | float | `1` | Temperature parameter for the AI model. This controls the randomness of the output, where a higher value (e.g., 1.0) makes the output more random, and a lower value (e.g., 0.0) makes it more deterministic. |
154-
| server.ai.topP | float | `1` | Top-p (nucleus sampling) parameter for the AI model. This controls Controls the probability mass to consider for sampling, where a higher value leads to greater diversity in the generated content (typically ranging from 0 to 1) |
154+
| server.ai.topP | float | `1` | Top-p (nucleus sampling) parameter for the AI model. This controls the probability mass to consider for sampling, where a higher value leads to greater diversity in the generated content (typically ranging from 0 to 1) |
155155
| server.enableRbac | bool | `false` | Enable RBAC authorization if set to true. |
156156
| server.image.repo | string | `"kusionstack/karpor"` | Repository for Karpor server image. |
157157
| server.image.tag | string | `""` | Tag for Karpor server image. Defaults to the chart's appVersion if not specified. |

0 commit comments

Comments
 (0)