@nocobase/plugin-ai 2.3.0-alpha.1 → 2.3.0-beta.3

package/dist/ai/docs/nocobase/ai-dev/watermark-plugin.md

@@ -85,6 +85,8 @@ yarn pm create @my-project/plugin-watermark
 
 AI generates a standard plugin directory structure under `packages/plugins/@my-project/plugin-watermark/`.
 
+Once the scaffold is created, start development mode so your code changes hot-reload: for a project created by `nb init`, run `nb source dev` from the project root (`<app-path>`); for a NocoBase source repository you cloned yourself, run `yarn dev` from the source root.
+
 ### 3. Write Server-Side Code
 
 AI will generate the following files:

package/dist/ai/docs/nocobase/ai-employees/block/ai-chat-box.md

@@ -0,0 +1,133 @@
+---
+pkg: '@nocobase/plugin-ai'
+title: 'AI Chat box block'
+description: 'User guide for NocoBase administrators and page builders covering how to add an AI Chat box block, configure conversation capabilities, set Work context, manage conversations, and add Actions.'
+keywords: 'AI Chat box,AI Employee,page block,Work context,Scope,Actions,NocoBase'
+---
+
+# AI Chat box block
+
+In NocoBase, **AI Chat box** is an AI conversation block that can be added directly to a page. You can place it on a business page to provide a fixed AI assistant entry point for that page.
+
+Each AI Chat box block has its own current conversation and input state. Page builders can also restrict the available AI employees, models, file uploads, web search, and work context to suit the current business scenario.
+
+:::tip Before you start
+
+First [configure an LLM service](../features/llm-service.md) and [enable at least one AI employee](../features/enable-ai-employee.md).
+
+:::
+
+## Add an AI Chat box block
+
+1. Open the page you want to configure.
+2. Click `UI Editor` in the upper-right corner to enter page editing mode.
+3. Click `Add block`.
+4. Under `Other blocks`, select `AI chat box`.
+
+![Select AI chat box from the Add block menu](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/add-ai-chat-box-block-3.png)
+
+## Understand the block structure
+
+![AI Chat box block](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/ai-chat-box-overview-2.png)
+
+An AI Chat box contains three areas from top to bottom:
+
+- **Top action area** — conversation list, Actions, custom actions, and new conversation buttons; a messages button also appears when the messages area is hidden
+- **Messages area** — displays messages in the current draft or conversation
+- **Sender area** — input box, context selection, file upload, web search, AI employee selection, model selection, send button, and disclaimer
+
+### Add display content inside the block body
+
+In page editing mode, click `Add block` inside the AI Chat box to add any of the following blocks above the chat area:
+
+- JS block
+- Iframe
+- Markdown
+
+These blocks are useful for displaying instructions, external pages, or supporting information. The internal Add block menu only provides these three block types and does not allow another AI Chat box to be nested inside it.
+
+## Configure the AI Chat box
+
+Move the pointer over the block and open its settings menu. Click `Edit chat box` to configure the conversation scope, default message, Work context, AI employees, and models.
+
+![Edit chat box settings dialog](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/edit-chat-box-settings-2.png)
+
+### Edit chat box settings
+
+| Setting | Description |
+| --- | --- |
+| `Scope` | Controls which AI Chat boxes share a conversation list. A new block uses its own block UID by default to keep conversations separate. |
+| `Background` | Adds a system prompt after the AI employee definition to provide the role, objective, or response requirements for the current page. |
+| `Default user message` | Prefills a default user message in the sender when a new conversation starts. |
+| `Work context` | Selects page blocks to place in a new draft by default. |
+| `AI employees` | Restricts the business AI employees that can be selected in this block. Leave it empty to allow all available business AI employees. |
+| `Models` | Restricts the models that can be selected in this block. Leave it empty to allow all available models. |
+
+### Other block settings
+
+| Setting | Description |
+| --- | --- |
+| `Show messages` | Controls whether the messages area is displayed directly in the block. When disabled, use the messages button at the top to open the right-side panel. |
+| `Sender placeholder` | Changes the placeholder shown in the sender. |
+| `Enable add context` | Shows or hides the context selection entry in the sender. |
+| `Enable upload files` | Shows or hides the file upload entry. When disabled, pasting a file does not start an upload. |
+| `Enable web search` | Shows or hides the web search switch. Disabling it also turns off web search for the current draft. |
+| `Enable employee select` | Shows or hides the AI employee selector. |
+| `Enable model select` | Shows or hides the model selector. |
+| `Show disclaimer` | Shows or hides the AI disclaimer below the sender. |
+
+## Configure Work context
+
+In `Work context` under `Edit chat box`, click the add context button, select `Pick block`, and then select the page block you want to provide to the AI. After saving, the selected block becomes the default work context for new conversations and can be removed from the sender before sending.
+
+## Hide the messages area and use the right-side panel
+
+After disabling `Show messages`, the block body only keeps the sender area. A messages button appears at the top; click it to open the messages panel from the right.
+
+![Right-side messages panel with the messages area hidden](https://static-docs.nocobase.com/ai-employees/block/ai-chat-box/2026-07-22/messages-side-panel-2.png)
+
+When the panel is open, the rest of the block is covered by an overlay. Click the overlay or click the messages button again to close the panel.
+
+This layout works well when the AI Chat box is used as a lightweight input entry on a page: keep only the sender visible and open the panel when you need to review messages.
+
+## Manage conversation history
+
+Click the conversation list button in the upper-left corner of the block to view conversation history under the current Scope.
+
+Keep these rules in mind:
+
+- Multiple AI Chat boxes with the same Scope can see the same conversation list
+- Each block still has its own current conversation, sender draft, AI employee, model, attachments, and context state
+- The global floating chatbox does not filter by block Scope, so it does not hide conversations with a Scope
+- After clearing Scope, the block no longer filters the conversation list by Scope and displays both conversations without a Scope and conversations using other Scopes
+
+Normally, keeping the Scope generated for a new block is enough to separate the history of each page assistant. Only configure the same Scope when multiple blocks need to share the same conversation list.
+
+## Add Actions
+
+In page editing mode, click `Actions` at the top of the block to add either of the following actions:
+
+- JS Action
+- AI employee
+
+After adding an AI employee, you can configure shortcut tasks for that employee.
+
+The `Chat box uid` setting in a shortcut task specifies which AI Chat box runs the task. An AI employee added directly inside an AI Chat box points to the current block UID by default.
+
+If the specified AI Chat box is not mounted, NocoBase reports that the target block cannot be found and does not fall back to the global floating chatbox. See [AI employee shortcut tasks](../features/task.md) for detailed configuration.
+
+## Configure a page-specific assistant
+
+The following steps create a lightweight AI assistant for a page:
+
+1. Add an AI Chat box block and move it to the appropriate position on the page.
+2. Enter a page-specific Background under `Edit chat box`.
+3. Select one or more Work contexts.
+4. Restrict the available employees and models under `AI employees` and `Models`.
+5. Exit editing mode, enter a question, and send it.
+
+## Notes
+
+- The AI Chat box block and the global floating chatbox in the lower-right corner are separate entry points; their current conversations and input states are not synchronized automatically
+- Only JS block, Iframe, and Markdown can be added from `Add block` inside an AI Chat box
+- Changing Scope affects the conversation list query and does not copy the conversation or draft currently open in another block

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/documents.md

@@ -17,7 +17,7 @@ After opening the knowledge base detail page, click Documents in the left sideba
 
 Click Upload in the upper-right corner to upload files. After upload, documents automatically enter segment generation and vectorization. Status first shows Pending, then changes to Success after processing. If processing fails, it shows Error, and an error icon appears next to the filename.
 
-Supported document types include: `txt`, `md`, `json`, `csv`, `xls`, `xlsx`, `pdf`, `doc`, `docx`, `ppt`, and `pptx`.
+Supported document types include: `txt`, `md`, `json`, `csv`, `xls`, `xlsx`, `pdf`, `doc`, `docx`, and `pptx`.
 
 :::tip PDF documents
 

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/index.md

@@ -13,7 +13,7 @@ A knowledge base is the foundation of RAG retrieval. You can add product manuals
 
 For most scenarios, a Local knowledge base is enough. Only consider Readonly or External knowledge bases when documents and vector data are already maintained by an external system.
 
-![](https://static-docs.nocobase.com/20260617003643.png)
+![](https://static-docs.nocobase.com/20260728222403.png)
 
 ## Open knowledge base management
 
@@ -23,15 +23,15 @@ Click a knowledge base card to open its detail page:
 
 - Documents is used to upload documents, run vectorization, and open segment management
 - Hit tests is used to test which segments can be matched by a query
-- Settings is used to adjust basic information, vector store, and default segmentation parameters
+- Settings is used to adjust basic information, vector configuration, and default segmentation parameters
 
-![](https://static-docs.nocobase.com/20260617004104.png)
+![](https://static-docs.nocobase.com/20260728222406.png)
 
 ## Create a knowledge base
 
 Click Add new in the upper-right corner to create a knowledge base. The menu shows three types: Local, Readonly, and External.
 
-![](https://static-docs.nocobase.com/20260617003505.png)
+![](https://static-docs.nocobase.com/20260728222404.png)
 
 The three knowledge base types have different capability boundaries:
 
@@ -45,19 +45,23 @@ Local knowledge bases are recommended by default. Only consider Readonly or Exte
 
 A Local knowledge base usually needs the following information:
 
-![](https://static-docs.nocobase.com/20260617003603.png)
+![](https://static-docs.nocobase.com/20260728222405.png)
 
 - Key: unique identifier of the knowledge base. It cannot be changed after creation
 - Name: knowledge base name
 - File storage: where original documents and segment files are stored
-- Vector store: vector store used to generate and retrieve vectors
+- Vector database: select a configured vector database. See [Vector database](../vector-database)
+- LLM service: select a configured LLM service that supports embedding models. See [LLM service management](../../features/llm-service)
+- Embedding model: select or enter the embedding model used to generate and retrieve vectors; available models update when the LLM service changes
 - Description: knowledge base description
 - Split document, Chunk size, and Chunk overlap: default segmentation parameters used after document upload
 - Enabled: whether the knowledge base is enabled
 
+A Readonly knowledge base does not require File storage or default segmentation parameters, but it still requires Vector database, LLM service, and Embedding model.
+
 :::tip Prerequisites
 
-Before creating a Local knowledge base, prepare two dependencies: file storage for original documents and segment files, see [File storage](../../../file-manager/storage/); and vector storage for generating and retrieving vectors, see [Vector database](../vector-database) and [Vector store](../vector-store).
+Before creating a Local knowledge base, prepare file storage, a vector database, and an LLM service that supports embedding models. File storage holds original documents and segment files; see [File storage](../../../file-manager/storage/index.md). Configure the vector database as described in [Vector database](../vector-database), and configure the LLM service as described in [LLM service management](../../features/llm-service).
 
 :::
 

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/knowledge-base/settings.md

@@ -1,17 +1,17 @@
 ---
 pkg: "@nocobase/plugin-ai-knowledge-base"
 title: "Settings"
-description: "Modify basic information, vector store, and default segmentation settings on the Settings page of a knowledge base, and understand the relation between knowledge-base-level and document-level segmentation settings."
-keywords: "knowledge base settings,segmentation settings,Chunk size,Chunk overlap,vector store,NocoBase"
+description: "Modify basic information, vector database, LLM service, embedding model, and default segmentation settings on the Settings page of a knowledge base."
+keywords: "knowledge base settings,vector database,LLM service,embedding model,segmentation settings,NocoBase"
 ---
 
 # Settings
 
 ## Open the Settings page
 
-After opening the knowledge base detail page, click Settings in the left sidebar. This page modifies basic information, file storage, vector store, and default segmentation settings of the current knowledge base.
+After opening the knowledge base detail page, click Settings in the left sidebar. This page modifies basic information, file storage, vector database, LLM service, embedding model, and default segmentation settings of the current knowledge base.
 
-![](https://static-docs.nocobase.com/20260617005832.png)
+![](https://static-docs.nocobase.com/20260728222407.png)
 
 ## Basic information
 
@@ -22,17 +22,21 @@ Local knowledge base settings include:
 | Key | Unique identifier of the knowledge base. It cannot be changed after creation |
 | Name | Knowledge base name |
 | File storage | Where documents and segment files are stored. It cannot be changed after creation |
-| Vector store | Vector store used by the current knowledge base |
+| Vector database | Vector database used by the current knowledge base |
+| LLM service | LLM service used to generate embeddings |
+| Embedding model | Embedding model used to generate and retrieve vectors |
 | Description | Knowledge base description |
 | Enabled | Whether the current knowledge base is enabled |
 
-:::tip Vector store changes
+:::tip Vector configuration changes
 
-After you modify Vector store, NocoBase asks for confirmation when saving. After the vector store changes, existing documents must be vectorized again before vector data can be written to the new vector store. Choose Save and vectorize to save the settings and vectorize immediately, or choose Save only to save the settings and later run Vectorization manually on the Documents page.
+After you modify Vector database, LLM service, or Embedding model, NocoBase asks for confirmation when saving. After the vector configuration changes, existing documents must be vectorized again. Choose Save and vectorize to save the settings and vectorize immediately, or choose Save only to save the settings and later run Vectorization manually on the Documents page.
+
+If the vector database connection settings change, the Documents page also prompts you to run vectorization again.
 
 :::
 
-![](https://static-docs.nocobase.com/20260617005951.png)
+![](https://static-docs.nocobase.com/20260728222408.png)
 
 ## Default segmentation parameters
 

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/rag.md

@@ -1,29 +1,59 @@
+---
+pkg: "@nocobase/plugin-ai-knowledge-base"
+title: "RAG Retrieval-Augmented Generation"
+description: "Enable RAG for AI employees, configure the Knowledge Base, Retrieval strategy, Top K, and Score, and control knowledge-base access through user roles."
+keywords: "RAG,retrieval-augmented generation,knowledge-base retrieval,Retrieval strategy,knowledge-base permissions,Top K,NocoBase"
+---
+
 # RAG Retrieval
 
 ## Introduction
 
-After configuring the knowledge base, you can enable the RAG feature in the AI employee settings.
+In NocoBase, **RAG (Retrieval-Augmented Generation)** enables an AI employee to retrieve relevant content from knowledge bases before answering a question.
+
+The knowledge bases an AI employee can actually use are determined by both the employee's `Knowledge Base` configuration and the knowledge-base permissions of the current user's roles. Only knowledge bases included in both scopes are searched.
+
+## Configure an AI employee's knowledge bases
+
+Go to the `AI employees` configuration page, select the AI employee for which you want to enable RAG, and click `Edit`. In the edit drawer, open the `Knowledge Base` tab and turn on `Enable`.
+
+![](https://static-docs.nocobase.com/ai-employee-knowledge-base-settings-202608171620.png)
+
+The available settings are:
+
+- `Knowledge Base` — Optional. If left empty, the AI employee searches all enabled knowledge bases accessible to the current user's roles. If you select knowledge bases, it searches only the selected knowledge bases that the user is allowed to access
+- `Retrieval strategy` — Controls when knowledge-base retrieval runs:
+  - `Retrieve on demand` — The AI employee retrieves knowledge-base content only when it determines that the current question requires it. New AI employees use this strategy by default, and it is the recommended option for most cases
+  - `Automatically retrieve for every question` — Retrieval runs before every user question is sent to the AI employee. Use this when every turn depends on knowledge-base content
+- `Knowledge Base Prompt` — Defines how retrieved content is provided to the AI employee. `{knowledgeBaseData}` is a fixed placeholder; do not remove or modify it
+- `Top K` — The maximum number of knowledge-base results returned by each retrieval. The range is 1–100, and the default is 3
+- `Score` — The minimum similarity score required for a result. The range is 0–1, and the default is 0.6. A higher value returns more relevant content, but may produce fewer results
+
+Click `Submit` to save the configuration.
+
+## Configure knowledge-base permissions
 
-With RAG enabled, when a user chats with an AI employee, the AI employee will use RAG retrieval to fetch documents from the knowledge base based on the user's message and reply based on the retrieved documents.
+Selecting knowledge bases for an AI employee does not give every user access to them. Go to `Users & Permissions / Roles & Permissions`, select the role assigned to the user, and then open `Permissions / Knowledge bases`.
 
-## Enable RAG
+Select `Available` for each knowledge base that the role should be allowed to access. To automatically grant this role access to knowledge bases created later, select `New knowledge bases are allowed by default`.
 
-Go to the AI employee plugin configuration page, click the `AI employees` tab to enter the AI employee management page.
+![](https://static-docs.nocobase.com/knowledge-base-role-permissions-202608171620.png)
 
+:::warning Note
 
-![20251023010811](https://static-docs.nocobase.com/20251023010811.png)
+The knowledge-base scope available to an AI employee is the intersection of its `Knowledge Base` configuration and the current user's role permissions. Unauthorized knowledge bases are automatically excluded.
 
+:::
 
-Select the AI employee for which you want to enable RAG, click the `Edit` button to enter the AI employee editing page.
+## When the user has no knowledge-base access
 
-In the `Knowledge base` tab, turn on the `Enable` switch.
+If knowledge bases are enabled for an AI employee but its configured scope has no overlap with the current user's role permissions, the AI employee first answers with information that does not depend on a knowledge base. It then appends a prominent notice explaining that no knowledge-base content was used because the user does not have access and advising the user to contact an administrator.
 
-- In `Knowledge Base Prompt`, enter the prompt for referencing the knowledge base. `{knowledgeBaseData}` is a fixed placeholder and should not be modified.
-- In `Knowledge Base`, select the configured knowledge base. See: [Knowledge Base](./knowledge-base/).
-- In the `Top K` input box, enter the number of documents to retrieve, the default is 3.
-- In the `Score` input box, enter the document relevance threshold for retrieval.
+![](https://static-docs.nocobase.com/ai-employee-no-knowledge-base-access-side-panel-202608171653.png)
 
-Click the `Submit` button to save the AI employee settings.
+If the user can access at least one knowledge base but the current question returns no relevant content, the no-permission notice is not displayed.
 
+## Related links
 
-![20251023010844](https://static-docs.nocobase.com/20251023010844.png)
+- [Knowledge Base](./knowledge-base/index.md) — Create and maintain knowledge bases used for RAG retrieval
+- [Roles and permissions](../../users-permissions/acl/permissions.md) — Configure system, menu, and data access for roles

package/dist/ai/docs/nocobase/ai-employees/knowledge-base/vector-database.md

@@ -10,10 +10,10 @@ Currently, the AI Knowledge Base plugin only has built-in support for PGVector,
 
 ## Vector Database Management
 
-Go to the AI Agent plugin configuration page, click the `Vector store` tab, and select `Vector database` to enter the vector database management page.
+Go to the AI employees plugin configuration page and click the top-level `Vector database` tab to open the vector database management page.
 
 
-![20251022233704](https://static-docs.nocobase.com/20251022233704.png)
+![20260728222401](https://static-docs.nocobase.com/20260728222401.png)
 
 
 Click the `Add new` button in the upper right corner to add a new `PGVector` vector database connection:
@@ -29,4 +29,4 @@ Click the `Add new` button in the upper right corner to add a new `PGVector` vec
 After entering all the necessary information, click the `Test` button to test if the vector database service is available, and click the `Submit` button to save the connection information.
 
 
-![20251022234644](https://static-docs.nocobase.com/20251022234644.png)
+![20260728222402](https://static-docs.nocobase.com/20260728222402.png)

package/dist/ai/docs/nocobase/ai-employees/workflow/nodes/knowledge/create-document.md

@@ -30,7 +30,7 @@ Where:
 
 The example uses the `Answers` / `Questions` collections and target knowledge base described in [Overview](./). Before configuring the workflow, confirm that:
 
-- A Local knowledge base has been created, with file storage and vector store configured. See [Knowledge base overview](../../../knowledge-base/knowledge-base) and [Vector store](../../../knowledge-base/vector-store)
+- A Local knowledge base has been created, with file storage, vector database, LLM service, and embedding model configured. See [Knowledge base overview](../../../knowledge-base/knowledge-base/index.md) and [Vector database](../../../knowledge-base/vector-database)
 - The `Answers.questions` relation field is ready. To review the collection structure, return to [Overview](./)
 - The workflow uses asynchronous execution. See [Workflow](../../../../workflow) for the basics
 

package/dist/ai/docs/nocobase/api/app/env.md

@@ -57,6 +57,8 @@ Whitelist for outbound HTTP requests initiated by the server. It applies to serv
 
 When this variable is not configured, NocoBase still allows `http` / `https` requests to keep existing deployments compatible. However, if the target is a loopback, private, link-local, or metadata address, or if a domain resolves to one of these addresses, the server logs a warning. Future versions may gradually tighten the default behavior. If your deployment needs to access internal services, configure an explicit whitelist in advance.
 
+When this variable is configured, the initial request and every redirect destination must match a whitelist entry. If a redirect points to a non-matching host, NocoBase stops before sending the redirected request.
+
 Supported entries include:
 
 - Exact IPv4 address, such as `192.168.1.10`

package/dist/ai/docs/nocobase/api/cli/api/resource/create.md

@@ -1,12 +1,12 @@
 ---
 title: "nb api resource create"
-description: "nb api resource create command reference: create a record in a selected NocoBase resource."
+description: "nb api resource create command reference: create one or more records in a selected NocoBase resource."
 keywords: "nb api resource create,NocoBase CLI,create record,CRUD"
 ---
 
 # nb api resource create
 
-Create a record in a selected resource. Pass record data as a JSON object through `--values`.
+Create records in a selected resource. Pass record data as a JSON object through `--values`, or as a JSON array of objects to create multiple records in a single request.
 
 ## Usage
 
@@ -21,7 +21,7 @@ nb api resource create --resource <resource> --values <json> [flags]
 | `--resource` | string | Resource name, required |
 | `--data-source` | string | Data source key, default `main` |
 | `--source-id` | string | Source record ID for association resources |
-| `--values` | string | Data for the new record as a JSON object, required |
+| `--values` | string | Data for the new records: a JSON object, or a JSON array of objects to create multiple records; required |
 | `--whitelist` | string[] | Fields allowed to write; repeatable or pass a JSON array |
 | `--blacklist` | string[] | Fields forbidden to write; repeatable or pass a JSON array |
 
@@ -31,6 +31,7 @@ Also supports common connection parameters from [`nb api resource`](./index.md).
 
 ```bash
 nb api resource create --resource users --values '{"nickname":"Ada"}'
+nb api resource create --resource users --values '[{"nickname":"Ada"},{"nickname":"Grace"}]'
 nb api resource create --resource posts.comments --source-id 1 --values '{"content":"Hello"}'
 ```