Skip to content

Commit 23671a1

Browse files
akhil-vamshi-konamakhil-vamshi-konam
committed
fix: formatting of markdown tables for better readability
1 parent 9f60137 commit 23671a1

3 files changed

Lines changed: 45 additions & 45 deletions

File tree

‎docs/self-hosting/govern/environment-variables.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -293,37 +293,37 @@ For setup instructions, supported models, and IAM permissions, see [Plane AI](/s
293293

294294
### Plane Intelligence (PI) settings
295295

296-
| Variable | Description | Default Value |
297-
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
298-
| **OPENAI_API_KEY** | API key for OpenAI services used by Plane Intelligence. | |
299-
| **OPENAI_BASE_URL** | Custom base URL for OpenAI-compatible API endpoints. | |
300-
| **CLAUDE_API_KEY** | API key for Anthropic Claude services used by Plane Intelligence. | |
301-
| **CLAUDE_BASE_URL** | Custom base URL for Claude API endpoints. | |
302-
| **GROQ_API_KEY** | API key for Groq services used by Plane Intelligence. | |
303-
| **GROQ_BASE_URL** | Custom base URL for Groq API endpoints. | |
304-
| **COHERE_API_KEY** | API key for Cohere services used by Plane Intelligence. | |
305-
| **COHERE_BASE_URL** | Custom base URL for Cohere API endpoints. | |
306-
| **CUSTOM_LLM_ENABLED** | Enable a custom OpenAI-compatible LLM provider. Set to `true` to enable. | false |
307-
| **CUSTOM_LLM_MODEL_KEY** | Model key identifier for the custom LLM. | gpt-oss-120b |
308-
| **CUSTOM_LLM_BASE_URL** | Base URL for the custom LLM API endpoint. | |
309-
| **CUSTOM_LLM_API_KEY** | API key for the custom LLM provider. | |
310-
| **CUSTOM_LLM_NAME** | Display name for the custom LLM in the Plane UI. | GPT-OSS-120B |
311-
| **CUSTOM_LLM_DESCRIPTION** | Description of the custom LLM shown in the Plane UI. | A self-hosted OpenAI-compatible model |
312-
| **CUSTOM_LLM_MAX_TOKENS** | Maximum token limit for the custom LLM. | 128000 |
313-
| **EMBEDDING_MODEL** | Model key for generating embeddings (e.g. `cohere/embed-v4.0`). Required for PI API startup when Plane AI is enabled. | |
314-
| **OPENSEARCH_ML_MODEL_ID** | OpenSearch ML model ID for the deployed embedding model. | |
296+
| Variable | Description | Default Value |
297+
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
298+
| **OPENAI_API_KEY** | API key for OpenAI services used by Plane Intelligence. | |
299+
| **OPENAI_BASE_URL** | Custom base URL for OpenAI-compatible API endpoints. | |
300+
| **CLAUDE_API_KEY** | API key for Anthropic Claude services used by Plane Intelligence. | |
301+
| **CLAUDE_BASE_URL** | Custom base URL for Claude API endpoints. | |
302+
| **GROQ_API_KEY** | API key for Groq services used by Plane Intelligence. | |
303+
| **GROQ_BASE_URL** | Custom base URL for Groq API endpoints. | |
304+
| **COHERE_API_KEY** | API key for Cohere services used by Plane Intelligence. | |
305+
| **COHERE_BASE_URL** | Custom base URL for Cohere API endpoints. | |
306+
| **CUSTOM_LLM_ENABLED** | Enable a custom OpenAI-compatible LLM provider. Set to `true` to enable. | false |
307+
| **CUSTOM_LLM_MODEL_KEY** | Model key identifier for the custom LLM. | gpt-oss-120b |
308+
| **CUSTOM_LLM_BASE_URL** | Base URL for the custom LLM API endpoint. | |
309+
| **CUSTOM_LLM_API_KEY** | API key for the custom LLM provider. | |
310+
| **CUSTOM_LLM_NAME** | Display name for the custom LLM in the Plane UI. | GPT-OSS-120B |
311+
| **CUSTOM_LLM_DESCRIPTION** | Description of the custom LLM shown in the Plane UI. | A self-hosted OpenAI-compatible model |
312+
| **CUSTOM_LLM_MAX_TOKENS** | Maximum token limit for the custom LLM. | 128000 |
313+
| **EMBEDDING_MODEL** | Model key for generating embeddings (e.g. `cohere/embed-v4.0`). Required for PI API startup when Plane AI is enabled. | |
314+
| **OPENSEARCH_ML_MODEL_ID** | OpenSearch ML model ID for the deployed embedding model. | |
315315
| **OPENSEARCH_EMBEDDING_DIMENSION** | Vector dimension for `knn_vector` fields; must match the embedding model and stay aligned with the API service. See [Semantic search](/self-hosting/govern/plane-ai/semantic-search). | 1536 |
316-
| **BR_AWS_ACCESS_KEY_ID** | AWS access key for Amazon Bedrock integration. | |
317-
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret key for Amazon Bedrock integration. | |
318-
| **BR_AWS_SESSION_TOKEN** | AWS session token for Amazon Bedrock integration (for temporary credentials). | |
319-
| **FASTAPI_APP_WORKERS** | Number of FastAPI workers for the PI service. | 1 |
320-
| **PLANE_OAUTH_STATE_EXPIRY_SECONDS** | Expiry time (in seconds) for PI OAuth state tokens. | 82800 |
321-
| **CELERY_VECTOR_SYNC_ENABLED** | Enable periodic vector synchronization for AI-powered search. | 0 |
322-
| **CELERY_VECTOR_SYNC_INTERVAL** | Interval (in seconds) for vector synchronization. | 3 |
323-
| **CELERY_WORKSPACE_PLAN_SYNC_ENABLED** | Enable periodic workspace plan synchronization. | 0 |
324-
| **CELERY_WORKSPACE_PLAN_SYNC_INTERVAL** | Interval (in seconds) for workspace plan synchronization. | 86400 |
325-
| **CELERY_DOCS_SYNC_ENABLED** | Enable periodic documents synchronization for AI indexing. | 0 |
326-
| **CELERY_DOCS_SYNC_INTERVAL** | Interval (in seconds) for documents synchronization. | 86400 |
316+
| **BR_AWS_ACCESS_KEY_ID** | AWS access key for Amazon Bedrock integration. | |
317+
| **BR_AWS_SECRET_ACCESS_KEY** | AWS secret key for Amazon Bedrock integration. | |
318+
| **BR_AWS_SESSION_TOKEN** | AWS session token for Amazon Bedrock integration (for temporary credentials). | |
319+
| **FASTAPI_APP_WORKERS** | Number of FastAPI workers for the PI service. | 1 |
320+
| **PLANE_OAUTH_STATE_EXPIRY_SECONDS** | Expiry time (in seconds) for PI OAuth state tokens. | 82800 |
321+
| **CELERY_VECTOR_SYNC_ENABLED** | Enable periodic vector synchronization for AI-powered search. | 0 |
322+
| **CELERY_VECTOR_SYNC_INTERVAL** | Interval (in seconds) for vector synchronization. | 3 |
323+
| **CELERY_WORKSPACE_PLAN_SYNC_ENABLED** | Enable periodic workspace plan synchronization. | 0 |
324+
| **CELERY_WORKSPACE_PLAN_SYNC_INTERVAL** | Interval (in seconds) for workspace plan synchronization. | 86400 |
325+
| **CELERY_DOCS_SYNC_ENABLED** | Enable periodic documents synchronization for AI indexing. | 0 |
326+
| **CELERY_DOCS_SYNC_INTERVAL** | Interval (in seconds) for documents synchronization. | 86400 |
327327

328328
::: details Community Edition
329329

‎docs/self-hosting/govern/plane-ai/custom-llm.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ keywords: custom llm, self-hosted llm, ollama, litellm, groq, aws bedrock, plane
88

99
Plane AI supports one custom LLM alongside OpenAI and Anthropic. Pick the provider type that fits your setup:
1010

11-
| Provider type | Use when |
12-
| --- | --- |
11+
| Provider type | Use when |
12+
| --------------------- | ----------------------------------------------------------------------------------------------------- |
1313
| **OpenAI-compatible** | Your model is served via an OpenAI Chat Completions API (Ollama, Groq, vLLM, LiteLLM, Cerebras, etc.) |
14-
| **AWS Bedrock** | You're accessing models through Amazon Bedrock |
14+
| **AWS Bedrock** | You're accessing models through Amazon Bedrock |
1515

1616
:::warning
1717
Use a model with at least 1 trillion parameters. Smaller models produce degraded output across Plane AI features.

‎docs/self-hosting/govern/plane-ai/semantic-search.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ This builds on the OpenSearch connection configured in [Get started with Plane A
1212

1313
## Supported embedding models
1414

15-
| Provider | Model | Dimension |
16-
| --- | --- | --- |
17-
| **Cohere** | `cohere/embed-v4.0` | 1536 |
18-
| | `cohere/embed-english-v3.0` | 1024 |
19-
| | `cohere/embed-english-v2.0` | 4096 |
20-
| **OpenAI** | `openai/text-embedding-ada-002` | 1536 |
21-
| | `openai/text-embedding-3-small` | 1536 |
22-
| | `openai/text-embedding-3-large` | 3072 |
23-
| **AWS Bedrock** | `bedrock/amazon.titan-embed-text-v1` | 1536 |
24-
| | `bedrock/amazon.titan-embed-text-v2` | 1024 |
25-
| | `bedrock/cohere.embed-english-v3` | 1024 |
26-
| | `bedrock/cohere.embed-multilingual-v3` | 1024 |
15+
| Provider | Model | Dimension |
16+
| --------------- | -------------------------------------- | --------- |
17+
| **Cohere** | `cohere/embed-v4.0` | 1536 |
18+
| | `cohere/embed-english-v3.0` | 1024 |
19+
| | `cohere/embed-english-v2.0` | 4096 |
20+
| **OpenAI** | `openai/text-embedding-ada-002` | 1536 |
21+
| | `openai/text-embedding-3-small` | 1536 |
22+
| | `openai/text-embedding-3-large` | 3072 |
23+
| **AWS Bedrock** | `bedrock/amazon.titan-embed-text-v1` | 1536 |
24+
| | `bedrock/amazon.titan-embed-text-v2` | 1024 |
25+
| | `bedrock/cohere.embed-english-v3` | 1024 |
26+
| | `bedrock/cohere.embed-multilingual-v3` | 1024 |
2727

2828
## Step 1 — Configure the embedding model
2929

0 commit comments

Comments
 (0)