refactor: how to add a node type in workflow (#558)

backend/domain/workflow/internal/nodes/knowledge/adaptor.go

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2025 coze-dev Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package knowledge
+
+import (
+	"fmt"
+
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/crossdomain/knowledge"
+)
+
+func convertParsingType(p string) (knowledge.ParseMode, error) {
+	switch p {
+	case "fast":
+		return knowledge.FastParseMode, nil
+	case "accurate":
+		return knowledge.AccurateParseMode, nil
+	default:
+		return "", fmt.Errorf("invalid parsingType: %s", p)
+	}
+}
+
+func convertChunkType(p string) (knowledge.ChunkType, error) {
+	switch p {
+	case "custom":
+		return knowledge.ChunkTypeCustom, nil
+	case "default":
+		return knowledge.ChunkTypeDefault, nil
+	default:
+		return "", fmt.Errorf("invalid ChunkType: %s", p)
+	}
+}
+func convertRetrievalSearchType(s int64) (knowledge.SearchType, error) {
+	switch s {
+	case 0:
+		return knowledge.SearchTypeSemantic, nil
+	case 1:
+		return knowledge.SearchTypeHybrid, nil
+	case 20:
+		return knowledge.SearchTypeFullText, nil
+	default:
+		return "", fmt.Errorf("invalid RetrievalSearchType %v", s)
+	}
+}

backend/domain/workflow/internal/nodes/knowledge/knowledge_deleter.go

@@ -21,27 +21,45 @@ import (
 	"errors"
 
 	"github.com/coze-dev/coze-studio/backend/domain/workflow/crossdomain/knowledge"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/entity"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/entity/vo"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/canvas/convert"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/nodes"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/schema"
 )
 
-type DeleterConfig struct {
-	KnowledgeID      int64
-	KnowledgeDeleter knowledge.KnowledgeOperator
-}
+type DeleterConfig struct{}
 
-type KnowledgeDeleter struct {
-	config *DeleterConfig
-}
-
-func NewKnowledgeDeleter(_ context.Context, cfg *DeleterConfig) (*KnowledgeDeleter, error) {
-	if cfg.KnowledgeDeleter == nil {
-		return nil, errors.New("knowledge deleter is required")
+func (d *DeleterConfig) Adapt(_ context.Context, n *vo.Node, _ ...nodes.AdaptOption) (*schema.NodeSchema, error) {
+	ns := &schema.NodeSchema{
+		Key:     vo.NodeKey(n.ID),
+		Type:    entity.NodeTypeKnowledgeDeleter,
+		Name:    n.Data.Meta.Title,
+		Configs: d,
 	}
-	return &KnowledgeDeleter{
-		config: cfg,
+
+	if err := convert.SetInputsForNodeSchema(n, ns); err != nil {
+		return nil, err
+	}
+
+	if err := convert.SetOutputTypesForNodeSchema(n, ns); err != nil {
+		return nil, err
+	}
+
+	return ns, nil
+}
+
+func (d *DeleterConfig) Build(_ context.Context, _ *schema.NodeSchema, _ ...schema.BuildOption) (any, error) {
+	return &Deleter{
+		knowledgeDeleter: knowledge.GetKnowledgeOperator(),
 	}, nil
 }
 
-func (k *KnowledgeDeleter) Delete(ctx context.Context, input map[string]any) (map[string]any, error) {
+type Deleter struct {
+	knowledgeDeleter knowledge.KnowledgeOperator
+}
+
+func (k *Deleter) Invoke(ctx context.Context, input map[string]any) (map[string]any, error) {
 	documentID, ok := input["documentID"].(string)
 	if !ok {
 		return nil, errors.New("documentID is required and must be a string")
@@ -51,7 +69,7 @@ func (k *KnowledgeDeleter) Delete(ctx context.Context, input map[string]any) (ma
 		DocumentID: documentID,
 	}
 
-	response, err := k.config.KnowledgeDeleter.Delete(ctx, req)
+	response, err := k.knowledgeDeleter.Delete(ctx, req)
 	if err != nil {
 		return nil, err
 	}

backend/domain/workflow/internal/nodes/knowledge/knowledge_indexer.go

@@ -24,7 +24,14 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/spf13/cast"
+
 	"github.com/coze-dev/coze-studio/backend/domain/workflow/crossdomain/knowledge"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/entity"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/entity/vo"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/canvas/convert"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/nodes"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/schema"
 	"github.com/coze-dev/coze-studio/backend/infra/contract/document/parser"
 )
 
@@ -32,30 +39,88 @@ type IndexerConfig struct {
 	KnowledgeID      int64
 	ParsingStrategy  *knowledge.ParsingStrategy
 	ChunkingStrategy *knowledge.ChunkingStrategy
-	KnowledgeIndexer knowledge.KnowledgeOperator
 }
 
-type KnowledgeIndexer struct {
-	config *IndexerConfig
+func (i *IndexerConfig) Adapt(_ context.Context, n *vo.Node, _ ...nodes.AdaptOption) (*schema.NodeSchema, error) {
+	ns := &schema.NodeSchema{
+		Key:     vo.NodeKey(n.ID),
+		Type:    entity.NodeTypeKnowledgeIndexer,
+		Name:    n.Data.Meta.Title,
+		Configs: i,
+	}
+
+	inputs := n.Data.Inputs
+	datasetListInfoParam := inputs.DatasetParam[0]
+	datasetIDs := datasetListInfoParam.Input.Value.Content.([]any)
+	if len(datasetIDs) == 0 {
+		return nil, fmt.Errorf("dataset ids is required")
+	}
+	knowledgeID, err := cast.ToInt64E(datasetIDs[0])
+	if err != nil {
+		return nil, err
+	}
+
+	i.KnowledgeID = knowledgeID
+	ps := inputs.StrategyParam.ParsingStrategy
+	parseMode, err := convertParsingType(ps.ParsingType)
+	if err != nil {
+		return nil, err
+	}
+	parsingStrategy := &knowledge.ParsingStrategy{
+		ParseMode:    parseMode,
+		ImageOCR:     ps.ImageOcr,
+		ExtractImage: ps.ImageExtraction,
+		ExtractTable: ps.TableExtraction,
+	}
+	i.ParsingStrategy = parsingStrategy
+
+	cs := inputs.StrategyParam.ChunkStrategy
+	chunkType, err := convertChunkType(cs.ChunkType)
+	if err != nil {
+		return nil, err
+	}
+	chunkingStrategy := &knowledge.ChunkingStrategy{
+		ChunkType: chunkType,
+		Separator: cs.Separator,
+		ChunkSize: cs.MaxToken,
+		Overlap:   int64(cs.Overlap * float64(cs.MaxToken)),
+	}
+	i.ChunkingStrategy = chunkingStrategy
+
+	if err = convert.SetInputsForNodeSchema(n, ns); err != nil {
+		return nil, err
+	}
+
+	if err = convert.SetOutputTypesForNodeSchema(n, ns); err != nil {
+		return nil, err
+	}
+
+	return ns, nil
 }
 
-func NewKnowledgeIndexer(_ context.Context, cfg *IndexerConfig) (*KnowledgeIndexer, error) {
-	if cfg.ParsingStrategy == nil {
+func (i *IndexerConfig) Build(_ context.Context, _ *schema.NodeSchema, _ ...schema.BuildOption) (any, error) {
+	if i.ParsingStrategy == nil {
 		return nil, errors.New("parsing strategy is required")
 	}
-	if cfg.ChunkingStrategy == nil {
+	if i.ChunkingStrategy == nil {
 		return nil, errors.New("chunking strategy is required")
 	}
-	if cfg.KnowledgeIndexer == nil {
-		return nil, errors.New("knowledge indexer is required")
-	}
-	return &KnowledgeIndexer{
-		config: cfg,
+	return &Indexer{
+		knowledgeID:      i.KnowledgeID,
+		parsingStrategy:  i.ParsingStrategy,
+		chunkingStrategy: i.ChunkingStrategy,
+		knowledgeIndexer: knowledge.GetKnowledgeOperator(),
 	}, nil
 }
 
-func (k *KnowledgeIndexer) Store(ctx context.Context, input map[string]any) (map[string]any, error) {
+type Indexer struct {
+	knowledgeID      int64
+	parsingStrategy  *knowledge.ParsingStrategy
+	chunkingStrategy *knowledge.ChunkingStrategy
+	knowledgeIndexer knowledge.KnowledgeOperator
+}
 
+func (k *Indexer) Invoke(ctx context.Context, input map[string]any) (map[string]any, error) {
 	fileURL, ok := input["knowledge"].(string)
 	if !ok {
 		return nil, errors.New("knowledge is required")
@@ -68,15 +133,15 @@ func (k *KnowledgeIndexer) Store(ctx context.Context, input map[string]any) (map
 	}
 
 	req := &knowledge.CreateDocumentRequest{
-		KnowledgeID:      k.config.KnowledgeID,
-		ParsingStrategy:  k.config.ParsingStrategy,
-		ChunkingStrategy: k.config.ChunkingStrategy,
+		KnowledgeID:      k.knowledgeID,
+		ParsingStrategy:  k.parsingStrategy,
+		ChunkingStrategy: k.chunkingStrategy,
 		FileURL:          fileURL,
 		FileName:         fileName,
 		FileExtension:    ext,
 	}
 
-	response, err := k.config.KnowledgeIndexer.Store(ctx, req)
+	response, err := k.knowledgeIndexer.Store(ctx, req)
 	if err != nil {
 		return nil, err
 	}

backend/domain/workflow/internal/nodes/knowledge/knowledge_retrieve.go

@@ -20,7 +20,14 @@ import (
 	"context"
 	"errors"
 
+	"github.com/spf13/cast"
+
 	"github.com/coze-dev/coze-studio/backend/domain/workflow/crossdomain/knowledge"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/entity"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/entity/vo"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/canvas/convert"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/nodes"
+	"github.com/coze-dev/coze-studio/backend/domain/workflow/internal/schema"
 	"github.com/coze-dev/coze-studio/backend/pkg/lang/slices"
 )
 
@@ -29,37 +36,136 @@ const outputList = "outputList"
 type RetrieveConfig struct {
 	KnowledgeIDs      []int64
 	RetrievalStrategy *knowledge.RetrievalStrategy
-	Retriever         knowledge.KnowledgeOperator
 }
 
-type KnowledgeRetrieve struct {
-	config *RetrieveConfig
+func (r *RetrieveConfig) Adapt(_ context.Context, n *vo.Node, _ ...nodes.AdaptOption) (*schema.NodeSchema, error) {
+	ns := &schema.NodeSchema{
+		Key:     vo.NodeKey(n.ID),
+		Type:    entity.NodeTypeKnowledgeRetriever,
+		Name:    n.Data.Meta.Title,
+		Configs: r,
+	}
+
+	inputs := n.Data.Inputs
+	datasetListInfoParam := inputs.DatasetParam[0]
+	datasetIDs := datasetListInfoParam.Input.Value.Content.([]any)
+	knowledgeIDs := make([]int64, 0, len(datasetIDs))
+	for _, id := range datasetIDs {
+		k, err := cast.ToInt64E(id)
+		if err != nil {
+			return nil, err
+		}
+		knowledgeIDs = append(knowledgeIDs, k)
+	}
+	r.KnowledgeIDs = knowledgeIDs
+
+	retrievalStrategy := &knowledge.RetrievalStrategy{}
+
+	var getDesignatedParamContent = func(name string) (any, bool) {
+		for _, param := range inputs.DatasetParam {
+			if param.Name == name {
+				return param.Input.Value.Content, true
+			}
+		}
+		return nil, false
+	}
+
+	if content, ok := getDesignatedParamContent("topK"); ok {
+		topK, err := cast.ToInt64E(content)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.TopK = &topK
+	}
+
+	if content, ok := getDesignatedParamContent("useRerank"); ok {
+		useRerank, err := cast.ToBoolE(content)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.EnableRerank = useRerank
+	}
+
+	if content, ok := getDesignatedParamContent("useRewrite"); ok {
+		useRewrite, err := cast.ToBoolE(content)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.EnableQueryRewrite = useRewrite
+	}
+
+	if content, ok := getDesignatedParamContent("isPersonalOnly"); ok {
+		isPersonalOnly, err := cast.ToBoolE(content)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.IsPersonalOnly = isPersonalOnly
+	}
+
+	if content, ok := getDesignatedParamContent("useNl2sql"); ok {
+		useNl2sql, err := cast.ToBoolE(content)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.EnableNL2SQL = useNl2sql
+	}
+
+	if content, ok := getDesignatedParamContent("minScore"); ok {
+		minScore, err := cast.ToFloat64E(content)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.MinScore = &minScore
+	}
+
+	if content, ok := getDesignatedParamContent("strategy"); ok {
+		strategy, err := cast.ToInt64E(content)
+		if err != nil {
+			return nil, err
+		}
+		searchType, err := convertRetrievalSearchType(strategy)
+		if err != nil {
+			return nil, err
+		}
+		retrievalStrategy.SearchType = searchType
+	}
+
+	r.RetrievalStrategy = retrievalStrategy
+
+	if err := convert.SetInputsForNodeSchema(n, ns); err != nil {
+		return nil, err
+	}
+
+	if err := convert.SetOutputTypesForNodeSchema(n, ns); err != nil {
+		return nil, err
+	}
+
+	return ns, nil
 }
 
-func NewKnowledgeRetrieve(_ context.Context, cfg *RetrieveConfig) (*KnowledgeRetrieve, error) {
-	if cfg == nil {
-		return nil, errors.New("cfg is required")
+func (r *RetrieveConfig) Build(_ context.Context, _ *schema.NodeSchema, _ ...schema.BuildOption) (any, error) {
+	if len(r.KnowledgeIDs) == 0 {
+		return nil, errors.New("knowledge ids are required")
 	}
 
-	if cfg.Retriever == nil {
-		return nil, errors.New("retriever is required")
-	}
-
-	if len(cfg.KnowledgeIDs) == 0 {
-		return nil, errors.New("knowledgeI ids is required")
-	}
-
-	if cfg.RetrievalStrategy == nil {
+	if r.RetrievalStrategy == nil {
 		return nil, errors.New("retrieval strategy is required")
 	}
 
-	return &KnowledgeRetrieve{
-		config: cfg,
+	return &Retrieve{
+		knowledgeIDs:      r.KnowledgeIDs,
+		retrievalStrategy: r.RetrievalStrategy,
+		retriever:         knowledge.GetKnowledgeOperator(),
 	}, nil
 }
 
-func (kr *KnowledgeRetrieve) Retrieve(ctx context.Context, input map[string]any) (map[string]any, error) {
+type Retrieve struct {
+	knowledgeIDs      []int64
+	retrievalStrategy *knowledge.RetrievalStrategy
+	retriever         knowledge.KnowledgeOperator
+}
 
+func (kr *Retrieve) Invoke(ctx context.Context, input map[string]any) (map[string]any, error) {
 	query, ok := input["Query"].(string)
 	if !ok {
 		return nil, errors.New("capital query key is required")
@@ -67,11 +173,11 @@ func (kr *KnowledgeRetrieve) Retrieve(ctx context.Context, input map[string]any)
 
 	req := &knowledge.RetrieveRequest{
 		Query:             query,
-		KnowledgeIDs:      kr.config.KnowledgeIDs,
-		RetrievalStrategy: kr.config.RetrievalStrategy,
+		KnowledgeIDs:      kr.knowledgeIDs,
+		RetrievalStrategy: kr.retrievalStrategy,
 	}
 
-	response, err := kr.config.Retriever.Retrieve(ctx, req)
+	response, err := kr.retriever.Retrieve(ctx, req)
 	if err != nil {
 		return nil, err
 	}