Skip to content

Commit 75883fe

Browse files
committed
[DOCSW-685] docs: restructure Plane AI page to reflect embedding model is optional
1 parent 92279d1 commit 75883fe

1 file changed

Lines changed: 32 additions & 11 deletions

File tree

docs/self-hosting/govern/plane-ai.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
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.
44
keywords: plane ai, Plane ai, self-hosted ai, llm configuration, embedding models, semantic search, openai, anthropic, cohere
55
---
66

77
# Configure Plane AI <Badge type="info" text="Commercial Edition" />
88

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.
1010

1111
For an overview of what Plane AI can do, see the [Plane AI](https://docs.plane.so/ai/pi-chat).
1212

@@ -15,9 +15,16 @@ For an overview of what Plane AI can do, see the [Plane AI](https://docs.plane.s
1515
You'll need:
1616

1717
- 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).
1918
- 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+
:::
2128

2229
## Supported models
2330

@@ -60,7 +67,7 @@ The custom model should have at least 1 trillion parameters for all Plane AI fea
6067

6168
### Embedding models
6269

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:
6471

6572
| Provider | Supported models | Dimension |
6673
| --------------- | -------------------------------------- | --------- |
@@ -113,7 +120,7 @@ This activates the Plane AI API, worker, beat-worker, and migrator workloads. Re
113120
:::
114121

115122
:::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).
117124
:::
118125

119126
## Configure an LLM provider
@@ -160,9 +167,11 @@ GROQ_API_KEY=your-groq-api-key
160167

161168
This enables voice input in Plane AI. It's not required for LLM or semantic search features.
162169

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.
164173

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.
166175

167176
### Configure OpenSearch connection
168177

@@ -175,7 +184,11 @@ OPENSEARCH_INDEX_PREFIX=plane
175184

176185
### Configure an embedding model
177186

178-
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+
:::
179192

180193
#### Option A: Use an existing OpenSearch model ID
181194

@@ -272,7 +285,11 @@ helm upgrade --install plane-app plane/plane-enterprise \
272285

273286
## Vectorize existing data
274287

275-
Generate embeddings for your existing content by running this command in the API container.
288+
::: info Only needed for semantic search
289+
Skip this section if you haven't configured OpenSearch and an embedding model. Vectorization is only required for semantic search functionality.
290+
:::
291+
292+
If you configured OpenSearch and an embedding model, generate embeddings for your existing content by running this command in the API container.
276293

277294
**Docker:**
278295

@@ -308,7 +325,11 @@ python manage.py manage_search_index --background --vectorize document index --f
308325

309326
Once configured:
310327

311-
- Plane AI is available across your workspace.
328+
- Plane AI chat, duplicate detection, and LLM-powered features are available across your workspace.
329+
330+
**If you configured OpenSearch and an embedding model:**
331+
332+
- Semantic search is enabled across work items, pages, and projects.
312333
- New content (work items, pages, comments) is automatically vectorized in the background.
313334
- Semantic search stays synchronized without manual intervention.
314335

0 commit comments

Comments
 (0)