@nocobase/plugin-ai 2.2.0-alpha.1 → 2.2.0-alpha.10

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/checkbox-group.md

@@ -1,9 +1,111 @@
+---
+title: "Checkbox group"
+description: "The Checkbox group field stores multiple values selected from a visible group of fixed options."
+keywords: "Checkbox group,checkboxGroup,field,Field interface,NocoBase"
+---
+
 # Checkbox group
 
 ## Introduction
 
-## Field configuration
+In NocoBase, the **Checkbox group** field stores multiple selected option values.
+
+It is suitable for service scope, applicable channels, requirement tags, and other multi-choice options that users should compare directly. Use Multiple select when the option list is long.
+
+## Use cases
+
+Checkbox group fields are suitable for these business scenarios:
+
+- Service scope
+- Applicable channels
+- Requirement tags
+- Other visible multi-choice options
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Checkbox group** to create this field.
+
+![Configure a Checkbox group field](https://static-docs.nocobase.com/20260709231244.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Checkbox group uses `checkboxGroup`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Service scope`, `Applicable channels`, or `Requirement tags`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Checkbox group uses `array` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Supports required validation and configured option ranges. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Checkbox group field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `checkboxGroup`. |
+| Default Field type | `array`. |
+| Available Field types | `array`, `json`. |
+| Page component | Uses a Checkbox group component in edit mode. |
+| Filtering | Supports option filters for selected values and empty values. |
+| Sorting | Supports sorting in Table blocks where supported by the data source. |
+| Validation | Supports required validation and configured option ranges. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Checkbox group field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Checkbox group field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Checkbox group fields are suitable for visible multi-choice business values.
+
+![Use a Checkbox group field in a page](https://static-docs.nocobase.com/20260709230421.png)
+
+
+| Scenario | Use |
+| --- | --- |
+| Form block | Select multiple visible options. |
+| Table block | Display and filter selected options. |
+| Details block | Display selected option values. |
+| Workflows and permissions | Use selected values in business conditions. |
 
-## Example
+## Related links
 
-To be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/checkbox.md

@@ -1,13 +1,111 @@
+---
+title: "Checkbox"
+description: "The Checkbox field stores a true or false value for a binary business state."
+keywords: "Checkbox,checkbox,field,Field interface,NocoBase"
+---
+
 # Checkbox
 
 ## Introduction
 
-## Field configuration
+In NocoBase, the **Checkbox** field stores a true or false value.
+
+It is suitable for business states such as enabled, completed, and invoiced. Use a Select or Radio group when the field needs more than two states.
+
+## Use cases
+
+Checkbox fields are suitable for these business scenarios:
+
+- Whether a record is enabled
+- Whether a task is complete
+- Whether an invoice has been issued
+- Other binary business states
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Checkbox** to create this field.
+
+![Configure a Checkbox field](https://static-docs.nocobase.com/20240512180122.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Checkbox uses `checkbox`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Enabled`, `Completed`, or `Invoiced`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Checkbox uses `boolean` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Supports required validation and default values. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Checkbox field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `checkbox`. |
+| Default Field type | `boolean`. |
+| Available Field types | `boolean`. |
+| Page component | Uses a Checkbox or Switch component in edit mode. |
+| Filtering | Supports boolean filters such as is true, is false, is empty, and is not empty. |
+| Sorting | Supports sorting in Table blocks. |
+| Validation | Supports required validation and default values. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Checkbox field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Checkbox field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Checkbox fields are suitable for binary states in forms, lists, and workflows.
 
+![Use a Checkbox field in a page](https://static-docs.nocobase.com/20260709225738.png)
 
-![20240512180122](https://static-docs.nocobase.com/20240512180122.png)
 
+| Scenario | Use |
+| --- | --- |
+| Form block | Select or clear a binary state. |
+| Table block | Display, sort, and filter a state. |
+| Details block | Display the state of one record. |
+| Workflows and permissions | Use the value in true-or-false conditions. |
 
-## Example
+## Related links
 
-to be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/china-region.md

@@ -1,13 +1,116 @@
-# China Region
+---
+title: "China region"
+description: "The China region field selects administrative divisions such as provinces, cities, and districts in China."
+keywords: "China region,china region,address,choice field,NocoBase"
+---
+
+# China region (deprecated)
 
 ## Introduction
 
-## Field configuration
+:::warning Note
+
+The China region field is deprecated. Use a relation field connected to a Tree collection instead.
+
+:::
+
+In NocoBase, **China region** selects Chinese administrative divisions such as provinces, cities, and districts.
+
+It is suitable for customer addresses, store addresses, service areas, and other scenarios that need a structured region selection. It is easier to filter and aggregate than a manually entered address.
+
+To store a complete street address, use [Input](../basic/input.md) or [Textarea](../basic/textarea.md) for street and building information.
+
+## Use cases
+
+China region is suitable for these business scenarios:
+
+- Customer province, city, and district
+- Store service area
+- Project implementation area
+- Administrative divisions in shipping addresses
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **China region** to create the field.
+
+![Create a China region field](https://static-docs.nocobase.com/20240512180305.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. China region uses `chinaRegion`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Region`, `Service area`, or `Shipping region`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. China region values are normally stored as structured values; the actual Field type depends on field configuration. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Configure required validation and selection level as needed. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `chinaRegion`. |
+| Default Field type | `json`. |
+| Available Field types | `json`, `string`, depending on actual field configuration. |
+| Page component | Uses an administrative-region selector in edit mode. |
+| Filtering | Supports filtering by region value; capabilities depend on field configuration. |
+| Sorting | It is usually not used for sorting. |
+| Validation | Supports base validation such as required. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they display and are used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a China region field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a China region field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
 
+## Use in pages
 
-![20240512180305](https://static-docs.nocobase.com/20240512180305.png)
+China region fields are suitable for addresses, regions, and statistical scenarios.
 
+| Scenario | Use |
+| --- | --- |
+| Form block | Select a province, city, or district. |
+| Details block | Display an administrative division. |
+| Filter block | Filter records by region. |
+| Chart block | Aggregate business data by region. |
 
-## Example
+## Related links
 
-To be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [Input](../basic/input.md) - Store detailed street addresses.
+- [Textarea](../basic/textarea.md) - Store longer address descriptions.
+- [Relation fields](../associations/index.md) - Relate a Tree collection for region data.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/multiple-select.md

@@ -1,13 +1,111 @@
-# Multiple Select
+---
+title: "Multiple select"
+description: "The Multiple select field stores multiple values from a fixed option set, such as tags and applicable scenarios."
+keywords: "Multiple select,multipleSelect,field,Field interface,NocoBase"
+---
+
+# Multiple select
 
 ## Introduction
 
-## Field configuration
+In NocoBase, the **Multiple select** field stores multiple selected option values.
+
+It is suitable for customer tags, applicable scenarios, issue categories, and other values where a record can have more than one option. Use Select when only one option is allowed.
+
+## Use cases
+
+Multiple select fields are suitable for these business scenarios:
+
+- Customer tags
+- Applicable scenarios
+- Issue categories
+- Multiple business labels
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Multiple select** to create this field.
+
+![Configure a Multiple select field](https://static-docs.nocobase.com/20240512180236.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Multiple select uses `multipleSelect`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Customer tags`, `Applicable scenarios`, or `Issue categories`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Multiple select uses `array` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Supports required validation and configured option ranges. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Multiple select field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `multipleSelect`. |
+| Default Field type | `array`. |
+| Available Field types | `array`, `json`. |
+| Page component | Uses a multi-select component in edit mode. |
+| Filtering | Supports option filters for selected values and empty values. |
+| Sorting | Supports sorting in Table blocks where supported by the data source. |
+| Validation | Supports required validation and configured option ranges. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Multiple select field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Multiple select field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Multiple select fields are suitable for tags, labels, and multi-choice business data.
 
+![Use a Multiple select field in a page](https://static-docs.nocobase.com/20260709230017.png)
 
-![20240512180236](https://static-docs.nocobase.com/20240512180236.png)
 
+| Scenario | Use |
+| --- | --- |
+| Form block | Select multiple options. |
+| Table block | Display and filter selected options. |
+| Details block | Display selected option values. |
+| Workflows and permissions | Use selected values in business conditions. |
 
-## Example
+## Related links
 
-to be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.

package/dist/ai/docs/nocobase/data-sources/data-modeling/collection-fields/choices/radio-group.md

@@ -1,9 +1,111 @@
-# Radio Group
+---
+title: "Radio group"
+description: "The Radio group field stores one option selected from a visible group of fixed options."
+keywords: "Radio group,radioGroup,field,Field interface,NocoBase"
+---
+
+# Radio group
 
 ## Introduction
 
-## Field configuration
+In NocoBase, the **Radio group** field stores one selected option value.
+
+It is suitable for priorities, approval results, types, and other single-choice options that users should compare directly. Use Select when the option list is long.
+
+## Use cases
+
+Radio group fields are suitable for these business scenarios:
+
+- Priority
+- Approval result
+- Type
+- Other visible single-choice options
+
+## Create and configure
+
+On the collection's **Configure fields** page, click **Add field** and select **Radio group** to create this field.
+
+![Configure a Radio group field](https://static-docs.nocobase.com/20260709231205.png)
+
+| Setting | Description |
+| --- | --- |
+| Field interface | The field interface. Radio group uses `radioGroup`, which determines how the field is entered and displayed in pages. |
+| Field display name | The name displayed for the field, such as `Priority`, `Approval result`, or `Type`. Use a name that business users can recognize. |
+| Field name | The field identifier used internally by APIs, relation fields, permissions, and workflows. It usually cannot be changed after creation. It supports only letters, numbers, and underscores, and must begin with a letter. |
+| Field type | The data-layer type. Radio group uses `string` by default. |
+| Default value | The default value. When a new record has no value, NocoBase can fill this value automatically. |
+| Validation rules | Validation rules. Supports required validation and configured option values. |
+| Description | A field description. Record the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Field names are referenced by page blocks, permissions, workflows, and APIs after creation. Confirm the name before creating the field to avoid later configuration changes.
+
+:::
+
+## Field behavior
+
+The default behavior of a Radio group field is as follows:
+
+| Behavior | Description |
+| --- | --- |
+| Default Field interface | `radioGroup`. |
+| Default Field type | `string`. |
+| Available Field types | `string`. |
+| Page component | Uses a Radio group component in edit mode. |
+| Filtering | Supports option filters such as equals, does not equal, is empty, and is not empty. |
+| Sorting | Supports sorting in Table blocks. |
+| Validation | Supports required validation and configured option values. |
+
+## Edit configuration
+
+After creation, click **Edit** beside the field to edit its configuration. Edit fields to adjust how they are displayed and used in NocoBase, such as the display name, description, default value, validation rules, or field-specific settings.
+
+When a field comes from a synchronized main-database table, editing usually maps the database field to a NocoBase Field type and Field interface.
+
+| Setting | Can be edited | Description |
+| --- | --- | --- |
+| Field display name | Yes | Changes the name displayed in the interface without changing the field identifier. |
+| Field name | No | The field identifier normally cannot be changed in the edit form after creation. |
+| Field interface | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Changes affect page input, display, and validation. |
+| Field type | Conditional | Main-database fields and synchronized fields can be adjusted during field mapping. Confirm that existing values can be used by the new type first. |
+| Default value | Yes | Adjusts the default value for new records. |
+| Validation rules | Yes | Adjusts field validation rules. |
+| Description | Yes | Adds the field meaning, entry requirements, data source, or maintainer. |
+
+:::warning Note
+
+Changing a Field type or Field interface is more than changing a display name. It affects field storage, input components, validation rules, filters, and workflow-variable usage. When the field contains substantial existing data, confirm that its data format is compatible first.
+
+:::
+
+## Delete field
+
+Click **Delete** beside a Radio group field to delete it. You can also select multiple fields and delete them in the main data source.
+
+Deleting a Radio group field created in the main database usually also deletes the actual database column and its values. For a synchronized or external-data-source field, the impact depends on the corresponding data source and field origin.
+
+:::danger Warning
+
+Deleting a field can affect page blocks, forms, filters, permissions, workflows, APIs, imports and exports, and existing data. Confirm that the field is no longer referenced by business configuration before deleting it.
+
+:::
+
+## Use in pages
+
+Radio group fields are suitable for visible single-choice business values.
+
+![Use a Radio group field in a page](https://static-docs.nocobase.com/20260709230347.png)
+
+
+| Scenario | Use |
+| --- | --- |
+| Form block | Select one visible option. |
+| Table block | Display, sort, and filter the selected option. |
+| Details block | Display the selected option. |
+| Workflows and permissions | Use the selected value in business conditions. |
 
-## Example
+## Related links
 
-to be added.
+- [Fields](../index.md) - Learn about field categories and mapping.
+- [General collection](../../../data-source-main/general-collection.md) - Create and manage fields in a collection.