feat: manually mirror opencoze's code from bytedance

Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf

backend/domain/workflow/crossdomain/knowledge/knowledge.go

@@ -0,0 +1,143 @@
+/*
+ * 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 (
+	"context"
+
+	"github.com/coze-dev/coze-studio/backend/infra/contract/document/parser"
+)
+
+type ParseMode string
+
+const (
+	FastParseMode     = "fast_mode"
+	AccurateParseMode = "accurate_mode"
+)
+
+type ChunkType string
+
+const (
+	ChunkTypeDefault ChunkType = "default"
+	ChunkTypeCustom  ChunkType = "custom"
+	ChunkTypeLeveled ChunkType = "leveled"
+)
+
+type ParsingStrategy struct {
+	ParseMode    ParseMode
+	ExtractImage bool
+	ExtractTable bool
+	ImageOCR     bool
+}
+type ChunkingStrategy struct {
+	ChunkType ChunkType
+	ChunkSize int64
+	Separator string
+	Overlap   int64
+}
+
+type CreateDocumentRequest struct {
+	KnowledgeID      int64
+	ParsingStrategy  *ParsingStrategy
+	ChunkingStrategy *ChunkingStrategy
+	FileURL          string
+	FileName         string
+	FileExtension    parser.FileExtension
+}
+type CreateDocumentResponse struct {
+	DocumentID int64
+	FileName   string
+	FileURL    string
+}
+
+type SearchType string
+
+const (
+	SearchTypeSemantic SearchType = "semantic"  // 语义
+	SearchTypeFullText SearchType = "full_text" // 全文
+	SearchTypeHybrid   SearchType = "hybrid"    // 混合
+)
+
+type RetrievalStrategy struct {
+	TopK       *int64
+	MinScore   *float64
+	SearchType SearchType
+
+	EnableNL2SQL       bool
+	EnableQueryRewrite bool
+	EnableRerank       bool
+	IsPersonalOnly     bool
+}
+
+type RetrieveRequest struct {
+	Query             string
+	KnowledgeIDs      []int64
+	RetrievalStrategy *RetrievalStrategy
+}
+
+type Slice struct {
+	DocumentID string `json:"documentId"`
+	Output     string `json:"output"`
+}
+
+type RetrieveResponse struct {
+	Slices []*Slice
+}
+
+var (
+	knowledgeOperatorImpl KnowledgeOperator
+)
+
+func GetKnowledgeOperator() KnowledgeOperator {
+	return knowledgeOperatorImpl
+}
+
+func SetKnowledgeOperator(k KnowledgeOperator) {
+	knowledgeOperatorImpl = k
+}
+
+type KnowledgeDetail struct {
+	ID          int64  `json:"id"`
+	Name        string `json:"name"`
+	Description string `json:"description"`
+	IconURL     string `json:"-"`
+	FormatType  int64  `json:"-"`
+}
+
+type ListKnowledgeDetailRequest struct {
+	KnowledgeIDs []int64
+}
+
+type ListKnowledgeDetailResponse struct {
+	KnowledgeDetails []*KnowledgeDetail
+}
+
+type DeleteDocumentRequest struct {
+	DocumentID string
+}
+
+type DeleteDocumentResponse struct {
+	IsSuccess bool
+}
+
+//go:generate  mockgen -destination knowledgemock/knowledge_mock.go --package knowledgemock -source knowledge.go
+type KnowledgeOperator interface {
+	Store(ctx context.Context, document *CreateDocumentRequest) (*CreateDocumentResponse, error)
+	Retrieve(context.Context, *RetrieveRequest) (*RetrieveResponse, error)
+	Delete(context.Context, *DeleteDocumentRequest) (*DeleteDocumentResponse, error)
+	ListKnowledgeDetail(context.Context, *ListKnowledgeDetailRequest) (*ListKnowledgeDetailResponse, error)
+}

backend/domain/workflow/crossdomain/knowledge/knowledgemock/knowledge_mock.go

@@ -0,0 +1,118 @@
+/*
+ * 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.
+ */
+
+// Code generated by MockGen. DO NOT EDIT.
+// Source: knowledge.go
+//
+// Generated by this command:
+//
+//	mockgen -destination knowledgemock/knowledge_mock.go --package knowledgemock -source knowledge.go
+//
+
+// Package knowledgemock is a generated GoMock package.
+package knowledgemock
+
+import (
+	context "context"
+	reflect "reflect"
+
+	knowledge "github.com/coze-dev/coze-studio/backend/domain/workflow/crossdomain/knowledge"
+	gomock "go.uber.org/mock/gomock"
+)
+
+// MockKnowledgeOperator is a mock of KnowledgeOperator interface.
+type MockKnowledgeOperator struct {
+	ctrl     *gomock.Controller
+	recorder *MockKnowledgeOperatorMockRecorder
+	isgomock struct{}
+}
+
+// MockKnowledgeOperatorMockRecorder is the mock recorder for MockKnowledgeOperator.
+type MockKnowledgeOperatorMockRecorder struct {
+	mock *MockKnowledgeOperator
+}
+
+// NewMockKnowledgeOperator creates a new mock instance.
+func NewMockKnowledgeOperator(ctrl *gomock.Controller) *MockKnowledgeOperator {
+	mock := &MockKnowledgeOperator{ctrl: ctrl}
+	mock.recorder = &MockKnowledgeOperatorMockRecorder{mock}
+	return mock
+}
+
+// EXPECT returns an object that allows the caller to indicate expected use.
+func (m *MockKnowledgeOperator) EXPECT() *MockKnowledgeOperatorMockRecorder {
+	return m.recorder
+}
+
+// Delete mocks base method.
+func (m *MockKnowledgeOperator) Delete(arg0 context.Context, arg1 *knowledge.DeleteDocumentRequest) (*knowledge.DeleteDocumentResponse, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "Delete", arg0, arg1)
+	ret0, _ := ret[0].(*knowledge.DeleteDocumentResponse)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// Delete indicates an expected call of Delete.
+func (mr *MockKnowledgeOperatorMockRecorder) Delete(arg0, arg1 any) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Delete", reflect.TypeOf((*MockKnowledgeOperator)(nil).Delete), arg0, arg1)
+}
+
+// ListKnowledgeDetail mocks base method.
+func (m *MockKnowledgeOperator) ListKnowledgeDetail(arg0 context.Context, arg1 *knowledge.ListKnowledgeDetailRequest) (*knowledge.ListKnowledgeDetailResponse, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "ListKnowledgeDetail", arg0, arg1)
+	ret0, _ := ret[0].(*knowledge.ListKnowledgeDetailResponse)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// ListKnowledgeDetail indicates an expected call of ListKnowledgeDetail.
+func (mr *MockKnowledgeOperatorMockRecorder) ListKnowledgeDetail(arg0, arg1 any) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListKnowledgeDetail", reflect.TypeOf((*MockKnowledgeOperator)(nil).ListKnowledgeDetail), arg0, arg1)
+}
+
+// Retrieve mocks base method.
+func (m *MockKnowledgeOperator) Retrieve(arg0 context.Context, arg1 *knowledge.RetrieveRequest) (*knowledge.RetrieveResponse, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "Retrieve", arg0, arg1)
+	ret0, _ := ret[0].(*knowledge.RetrieveResponse)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// Retrieve indicates an expected call of Retrieve.
+func (mr *MockKnowledgeOperatorMockRecorder) Retrieve(arg0, arg1 any) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Retrieve", reflect.TypeOf((*MockKnowledgeOperator)(nil).Retrieve), arg0, arg1)
+}
+
+// Store mocks base method.
+func (m *MockKnowledgeOperator) Store(ctx context.Context, document *knowledge.CreateDocumentRequest) (*knowledge.CreateDocumentResponse, error) {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "Store", ctx, document)
+	ret0, _ := ret[0].(*knowledge.CreateDocumentResponse)
+	ret1, _ := ret[1].(error)
+	return ret0, ret1
+}
+
+// Store indicates an expected call of Store.
+func (mr *MockKnowledgeOperatorMockRecorder) Store(ctx, document any) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Store", reflect.TypeOf((*MockKnowledgeOperator)(nil).Store), ctx, document)
+}