feat: create_empty_dataset api add the description parameter and update api docs (#9824)

api/controllers/console/datasets/datasets.py

@@ -102,6 +102,13 @@ class DatasetListApi(Resource):
             help="type is required. Name must be between 1 to 40 characters.",
             type=_validate_name,
         )
+        parser.add_argument(
+            "description",
+            type=str,
+            nullable=True,
+            required=False,
+            default="",
+        )
         parser.add_argument(
             "indexing_technique",
             type=str,
@@ -140,6 +147,7 @@ class DatasetListApi(Resource):
             dataset = DatasetService.create_empty_dataset(
                 tenant_id=current_user.current_tenant_id,
                 name=args["name"],
+                description=args["description"],
                 indexing_technique=args["indexing_technique"],
                 account=current_user,
                 permission=DatasetPermissionEnum.ONLY_ME,

api/controllers/service_api/dataset/dataset.py

@@ -66,6 +66,13 @@ class DatasetListApi(DatasetApiResource):
             help="type is required. Name must be between 1 to 40 characters.",
             type=_validate_name,
         )
+        parser.add_argument(
+            "description",
+            type=str,
+            nullable=True,
+            required=False,
+            default="",
+        )
         parser.add_argument(
             "indexing_technique",
             type=str,
@@ -108,6 +115,7 @@ class DatasetListApi(DatasetApiResource):
             dataset = DatasetService.create_empty_dataset(
                 tenant_id=tenant_id,
                 name=args["name"],
+                description=args["description"],
                 indexing_technique=args["indexing_technique"],
                 account=current_user,
                 permission=args["permission"],

api/services/dataset_service.py

@@ -140,6 +140,7 @@ class DatasetService:
     def create_empty_dataset(
         tenant_id: str,
         name: str,
+        description: Optional[str],
         indexing_technique: Optional[str],
         account: Account,
         permission: Optional[str] = None,
@@ -158,6 +159,7 @@ class DatasetService:
             )
         dataset = Dataset(name=name, indexing_technique=indexing_technique)
         # dataset = Dataset(name=name, provider=provider, config=config)
+        dataset.description = description
         dataset.created_by = account.id
         dataset.updated_by = account.id
         dataset.tenant_id = tenant_id

web/app/(commonLayout)/datasets/template/template.en.mdx

@@ -236,12 +236,31 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
       <Property name='name' type='string' key='name'>
         Knowledge name
       </Property>
+      <Property name='description' type='string' key='description'>
+        Knowledge description (optional)
+      </Property>
+      <Property name='indexing_technique' type='string' key='indexing_technique'>
+        Index Technique (optional)
+          - <code>high_quality</code> high_quality
+          - <code>economy</code> economy
+      </Property>
       <Property name='permission' type='string' key='permission'>
         Permission
           - <code>only_me</code> Only me
           - <code>all_team_members</code> All team members
           - <code>partial_members</code> Partial members
       </Property>
+      <Property name='provider' type='string' key='provider'>
+        Provider (optional, default: vendor)
+          - <code>vendor</code> vendor
+          - <code>external</code> external knowledge
+      </Property>
+      <Property name='external_knowledge_api_id' type='str' key='external_knowledge_api_id'>
+        External Knowledge api id (optional)
+      </Property>
+      <Property name='external_knowledge_id' type='str' key='external_knowledge_id'>
+        External Knowledge id (optional)
+      </Property>
     </Properties>
   </Col>
   <Col sticky>

web/app/(commonLayout)/datasets/template/template.zh.mdx

@@ -234,14 +234,33 @@ import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from
     ### Request Body
     <Properties>
       <Property name='name' type='string' key='name'>
-        知识库名称
+        知识库名称（必填）
+      </Property>
+      <Property name='description' type='string' key='description'>
+        知识库描述（选填）
+      </Property>
+      <Property name='indexing_technique' type='string' key='indexing_technique'>
+        索引模式（选填，建议填写）
+          - <code>high_quality</code> 高质量
+          - <code>economy</code> 经济
       </Property>
       <Property name='permission' type='string' key='permission'>
-        权限
+        权限（选填，默认only_me）
           - <code>only_me</code> 仅自己
           - <code>all_team_members</code> 所有团队成员
           - <code>partial_members</code> 部分团队成员
       </Property>
+      <Property name='provider' type='string' key='provider'>
+        provider，（选填，默认 vendor）
+          - <code>vendor</code> 上传文件
+          - <code>external</code> 外部知识库
+      </Property>
+      <Property name='external_knowledge_api_id' type='str' key='external_knowledge_api_id'>
+        外部知识库 API_ID（选填）
+      </Property>
+      <Property name='external_knowledge_id' type='str' key='external_knowledge_id'>
+        外部知识库 ID（选填）
+      </Property>
     </Properties>
   </Col>
   <Col sticky>