You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/self-hosting/govern/plane-ai.md
+32-11Lines changed: 32 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
title: Configure Plane AI
3
-
description: Configure Plane AI on your self-hosted Plane deployment. Set up LLM providers, embedding models, and semantic search for Plane's AI features.
3
+
description: Configure Plane AI on your self-hosted Plane deployment. Set up LLM providers for AI chat and duplicate detection. Optionally configure embedding models and semantic search.
# Configure Plane AI <Badgetype="info"text="Commercial Edition" />
8
8
9
-
Plane AI brings AI-powered features to your workspace, including natural language chat, duplicate detection, and semantic search across work items, pages, and projects. This guide walks you through configuring Plane AI on your self-hosted instance.
9
+
Plane AI brings AI-powered features to your workspace, including natural language chat, duplicate detection, and optionally semantic search across work items, pages, and projects. This guide walks you through configuring Plane AI on your self-hosted instance.
10
10
11
11
For an overview of what Plane AI can do, see the [Plane AI](https://docs.plane.so/ai/pi-chat).
12
12
@@ -15,9 +15,16 @@ For an overview of what Plane AI can do, see the [Plane AI](https://docs.plane.s
15
15
You'll need:
16
16
17
17
- A **separate database** for Plane AI. Plane AI requires its own database instance.
18
-
- An OpenSearch instance running version 2.19 or later (self-hosted or AWS OpenSearch) configured for [advanced search](/self-hosting/govern/advanced-search).
19
18
- At least one LLM provider API key or a custom OpenAI-compatible endpoint.
20
-
- At least one embedding model configured in OpenSearch.
19
+
20
+
**Optional (for semantic search):**
21
+
22
+
- An OpenSearch instance running version 2.19 or later (self-hosted or AWS OpenSearch) configured for [advanced search](/self-hosting/govern/advanced-search).
23
+
- An embedding model configured in OpenSearch.
24
+
25
+
::: tip
26
+
Without OpenSearch and an embedding model, Plane AI chat, duplicate detection, and other LLM-powered features will work normally. Semantic search across work items, pages, and projects will not be available.
27
+
:::
21
28
22
29
## Supported models
23
30
@@ -60,7 +67,7 @@ The custom model should have at least 1 trillion parameters for all Plane AI fea
60
67
61
68
### Embedding models
62
69
63
-
Embedding models power semantic search. Plane AI supports:
70
+
Embedding models power semantic search and are **optional**. If you're not using OpenSearch, you can skip configuring an embedding model. Plane AI supports:
@@ -113,7 +120,7 @@ This activates the Plane AI API, worker, beat-worker, and migrator workloads. Re
113
120
:::
114
121
115
122
:::tip Plane AI API startup checks
116
-
On start, the Plane AI container runs an embedding-dimension check against OpenSearch. **OpenSearch must be reachable** at `OPENSEARCH_URL`, and **`EMBEDDING_MODEL` must be set** in your environment or the service will not start. If existing index mappings or the deployed ML model disagree with **`OPENSEARCH_EMBEDDING_DIMENSION`**, startup fails until you align the configuration or rebuild indices (see [Changing the embedding dimension](#changing-the-embedding-dimension) below).
123
+
If you configure OpenSearch for semantic search, the Plane AI container runs an embedding-dimension check on start. **OpenSearch must be reachable** at `OPENSEARCH_URL`, and **`EMBEDDING_MODEL` must be set** when OpenSearch is configured, or the service will not start. If existing index mappings or the deployed ML model disagree with **`OPENSEARCH_EMBEDDING_DIMENSION`**, startup fails until you align the configuration or rebuild indices (see [Changing the embedding dimension](#changing-the-embedding-dimension) below).
This enables voice input in Plane AI. It's not required for LLM or semantic search features.
162
169
163
-
## Configure OpenSearch and an embedding model
170
+
## Configure OpenSearch and an embedding model (optional)
171
+
172
+
Plane AI uses OpenSearch for semantic indexing and retrieval, which powers semantic search across work items, pages, and projects. **This is optional** — Plane AI chat, duplicate detection, and other LLM-powered features work without OpenSearch or an embedding model.
164
173
165
-
Plane AI uses OpenSearch for semantic indexing and retrieval. If you haven't set up OpenSearch yet, complete the [OpenSearch for advanced search](/self-hosting/govern/advanced-search) guide first, then return here.
174
+
If you want to enable semantic search, complete the [OpenSearch for advanced search](/self-hosting/govern/advanced-search) guide first, then return here to configure the embedding model.
You must configure the `EMBEDDING_MODEL` so Plane AI knows which embedding model to construct queries for. Then configure exactly one embedding model deployment using one of these options.
187
+
If you're using OpenSearch for semantic search, configure the `EMBEDDING_MODEL` so Plane AI knows which embedding model to construct queries for. Then configure exactly one embedding model deployment using one of these options.
188
+
189
+
::: info Skip if not using semantic search
190
+
If you're not configuring OpenSearch, skip this section. Plane AI will work without semantic search capabilities.
191
+
:::
179
192
180
193
#### Option A: Use an existing OpenSearch model ID
0 commit comments