mirror of
https://github.com/langgenius/dify.git
synced 2026-09-03 23:47:16 +08:00
226 lines
8.6 KiB
Python
226 lines
8.6 KiB
Python
from typing import Literal
|
|
from uuid import UUID
|
|
|
|
from flask_restx import Resource
|
|
from sqlalchemy.orm import Session
|
|
from werkzeug.exceptions import NotFound
|
|
|
|
from controllers.common.controller_schemas import MetadataUpdatePayload
|
|
from controllers.common.schema import register_response_schema_models, register_schema_models
|
|
from controllers.common.session import with_session
|
|
from controllers.console import console_ns
|
|
from controllers.console.wraps import (
|
|
RBACPermission,
|
|
RBACResourceScope,
|
|
account_initialization_required,
|
|
enterprise_license_required,
|
|
model_validate,
|
|
rbac_permission_required,
|
|
setup_required,
|
|
with_current_tenant_id,
|
|
with_current_user,
|
|
)
|
|
from fields.dataset_fields import (
|
|
DatasetMetadataBuiltInFieldsResponse,
|
|
DatasetMetadataListResponse,
|
|
DatasetMetadataResponse,
|
|
)
|
|
from libs.helper import dump_response
|
|
from libs.login import login_required
|
|
from models.account import Account
|
|
from services.dataset_service import DatasetService
|
|
from services.entities.knowledge_entities.knowledge_entities import (
|
|
DocumentMetadataOperation,
|
|
MetadataArgs,
|
|
MetadataDetail,
|
|
MetadataOperationData,
|
|
)
|
|
from services.metadata_service import MetadataService
|
|
|
|
register_schema_models(
|
|
console_ns, MetadataArgs, MetadataOperationData, MetadataUpdatePayload, DocumentMetadataOperation, MetadataDetail
|
|
)
|
|
register_response_schema_models(
|
|
console_ns,
|
|
DatasetMetadataBuiltInFieldsResponse,
|
|
DatasetMetadataListResponse,
|
|
DatasetMetadataResponse,
|
|
)
|
|
|
|
|
|
@console_ns.route("/datasets/<uuid:dataset_id>/metadata")
|
|
class DatasetMetadataCreateApi(Resource):
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.response(201, "Metadata created successfully", console_ns.models[DatasetMetadataResponse.__name__])
|
|
@console_ns.expect(console_ns.models[MetadataArgs.__name__])
|
|
@with_current_user
|
|
@with_current_tenant_id
|
|
@rbac_permission_required(RBACResourceScope.DATASET, RBACPermission.DATASET_EDIT)
|
|
@with_session
|
|
@model_validate(MetadataArgs)
|
|
def post(
|
|
self,
|
|
req_data: MetadataArgs,
|
|
session: Session,
|
|
current_tenant_id: str,
|
|
current_user: Account,
|
|
dataset_id: UUID,
|
|
):
|
|
dataset_id_str = str(dataset_id)
|
|
dataset = DatasetService.get_dataset(dataset_id_str, session)
|
|
if dataset is None:
|
|
raise NotFound("Dataset not found.")
|
|
DatasetService.check_dataset_permission(dataset, current_user, session)
|
|
|
|
metadata = MetadataService.create_metadata(
|
|
dataset_id_str, req_data, current_user, current_tenant_id, session=session
|
|
)
|
|
return dump_response(DatasetMetadataResponse, metadata), 201
|
|
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.response(
|
|
200, "Metadata retrieved successfully", console_ns.models[DatasetMetadataListResponse.__name__]
|
|
)
|
|
@rbac_permission_required(RBACResourceScope.DATASET, RBACPermission.DATASET_CREATE_AND_MANAGEMENT)
|
|
@with_session(write=False)
|
|
def get(self, session: Session, dataset_id: UUID):
|
|
dataset_id_str = str(dataset_id)
|
|
dataset = DatasetService.get_dataset(dataset_id_str, session)
|
|
if dataset is None:
|
|
raise NotFound("Dataset not found.")
|
|
metadata = MetadataService.get_dataset_metadatas(dataset, session)
|
|
return dump_response(DatasetMetadataListResponse, metadata), 200
|
|
|
|
|
|
@console_ns.route("/datasets/<uuid:dataset_id>/metadata/<uuid:metadata_id>")
|
|
class DatasetMetadataApi(Resource):
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.response(200, "Metadata updated successfully", console_ns.models[DatasetMetadataResponse.__name__])
|
|
@console_ns.expect(console_ns.models[MetadataUpdatePayload.__name__])
|
|
@with_current_user
|
|
@with_current_tenant_id
|
|
@rbac_permission_required(RBACResourceScope.DATASET, RBACPermission.DATASET_EDIT)
|
|
@with_session
|
|
@model_validate(MetadataUpdatePayload)
|
|
def patch(
|
|
self,
|
|
req_data: MetadataUpdatePayload,
|
|
session: Session,
|
|
current_tenant_id: str,
|
|
current_user: Account,
|
|
dataset_id: UUID,
|
|
metadata_id: UUID,
|
|
):
|
|
name = req_data.name
|
|
|
|
dataset_id_str = str(dataset_id)
|
|
metadata_id_str = str(metadata_id)
|
|
dataset = DatasetService.get_dataset(dataset_id_str, session)
|
|
if dataset is None:
|
|
raise NotFound("Dataset not found.")
|
|
DatasetService.check_dataset_permission(dataset, current_user, session)
|
|
|
|
metadata = MetadataService.update_metadata_name(
|
|
dataset_id_str, metadata_id_str, name, current_user, current_tenant_id, session=session
|
|
)
|
|
return dump_response(DatasetMetadataResponse, metadata), 200
|
|
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.response(204, "Metadata deleted successfully")
|
|
@with_current_user
|
|
@rbac_permission_required(RBACResourceScope.DATASET, RBACPermission.DATASET_EDIT)
|
|
@with_session
|
|
def delete(self, session: Session, current_user: Account, dataset_id: UUID, metadata_id: UUID):
|
|
dataset_id_str = str(dataset_id)
|
|
metadata_id_str = str(metadata_id)
|
|
dataset = DatasetService.get_dataset(dataset_id_str, session)
|
|
if dataset is None:
|
|
raise NotFound("Dataset not found.")
|
|
DatasetService.check_dataset_permission(dataset, current_user, session)
|
|
|
|
MetadataService.delete_metadata(dataset_id_str, metadata_id_str, session)
|
|
# Frontend callers only await success and invalidate metadata caches; no response body is consumed.
|
|
return "", 204
|
|
|
|
|
|
@console_ns.route("/datasets/metadata/built-in")
|
|
class DatasetMetadataBuiltInFieldApi(Resource):
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.response(
|
|
200,
|
|
"Built-in fields retrieved successfully",
|
|
console_ns.models[DatasetMetadataBuiltInFieldsResponse.__name__],
|
|
)
|
|
def get(self):
|
|
built_in_fields = MetadataService.get_built_in_fields()
|
|
return dump_response(DatasetMetadataBuiltInFieldsResponse, {"fields": built_in_fields}), 200
|
|
|
|
|
|
@console_ns.route("/datasets/<uuid:dataset_id>/metadata/built-in/<string:action>")
|
|
class DatasetMetadataBuiltInFieldActionApi(Resource):
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.response(204, "Action completed successfully")
|
|
@with_current_user
|
|
@rbac_permission_required(RBACResourceScope.DATASET, RBACPermission.DATASET_EDIT)
|
|
@with_session
|
|
def post(self, session: Session, current_user: Account, dataset_id: UUID, action: Literal["enable", "disable"]):
|
|
dataset_id_str = str(dataset_id)
|
|
dataset = DatasetService.get_dataset(dataset_id_str, session)
|
|
if dataset is None:
|
|
raise NotFound("Dataset not found.")
|
|
DatasetService.check_dataset_permission(dataset, current_user, session)
|
|
|
|
match action:
|
|
case "enable":
|
|
MetadataService.enable_built_in_field(dataset, session)
|
|
case "disable":
|
|
MetadataService.disable_built_in_field(dataset, session)
|
|
# Frontend callers only await success and invalidate metadata caches; no response body is consumed.
|
|
return "", 204
|
|
|
|
|
|
@console_ns.route("/datasets/<uuid:dataset_id>/documents/metadata")
|
|
class DocumentMetadataEditApi(Resource):
|
|
@setup_required
|
|
@login_required
|
|
@account_initialization_required
|
|
@enterprise_license_required
|
|
@console_ns.expect(console_ns.models[MetadataOperationData.__name__])
|
|
@console_ns.response(
|
|
204,
|
|
"Documents metadata updated successfully",
|
|
)
|
|
@with_current_user
|
|
@rbac_permission_required(RBACResourceScope.DATASET, RBACPermission.DATASET_EDIT)
|
|
@with_session
|
|
@model_validate(MetadataOperationData)
|
|
def post(self, req_data: MetadataOperationData, session: Session, current_user: Account, dataset_id: UUID):
|
|
dataset_id_str = str(dataset_id)
|
|
dataset = DatasetService.get_dataset(dataset_id_str, session)
|
|
if dataset is None:
|
|
raise NotFound("Dataset not found.")
|
|
DatasetService.check_dataset_permission(dataset, current_user, session)
|
|
|
|
MetadataService.update_documents_metadata(dataset, req_data, current_user, session=session)
|
|
|
|
# Frontend callers only await success and invalidate caches; no response body is consumed.
|
|
return "", 204
|