coze-coding-dev-sdk 0.5.5 → 0.5.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3 @@
1
+ import { Command } from 'commander';
2
+ export declare const knowledgeCommand: Command;
3
+ //# sourceMappingURL=knowledge.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"knowledge.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/knowledge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC,eAAO,MAAM,gBAAgB,SACS,CAAC"}
@@ -0,0 +1,119 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.knowledgeCommand = void 0;
7
+ const commander_1 = require("commander");
8
+ const index_1 = require("../../index");
9
+ const chalk_1 = __importDefault(require("chalk"));
10
+ const ora_1 = __importDefault(require("ora"));
11
+ const utils_1 = require("../utils");
12
+ exports.knowledgeCommand = new commander_1.Command('knowledge')
13
+ .description('Knowledge Base tools');
14
+ exports.knowledgeCommand.command('search')
15
+ .description('Search for knowledge chunks')
16
+ .requiredOption('-q, --query <text>', 'Search query')
17
+ .option('-d, --dataset <name>', 'Dataset names (tables) to search in (can be used multiple times)', (value, previous) => previous.concat([value]), [])
18
+ .option('-k, --top-k <number>', 'Number of results to return', '5')
19
+ .option('-m, --min-score <number>', 'Minimum similarity score', '0.0')
20
+ .option('-H, --header <header>', 'Custom HTTP header (format: "Key: Value" or "Key=Value", can be used multiple times)', (value, previous) => previous.concat([value]), [])
21
+ .option('--verbose', 'Enable verbose logging to print HTTP request details', false)
22
+ .action(async (options) => {
23
+ const spinner = (0, ora_1.default)('Searching...').start();
24
+ try {
25
+ const config = new index_1.Config();
26
+ const customHeaders = (0, utils_1.parseHeaders)(options.header);
27
+ const client = new index_1.KnowledgeClient(config, customHeaders, options.verbose);
28
+ const results = await client.search(options.query, options.dataset.length > 0 ? options.dataset : undefined, parseInt(options.topK), parseFloat(options.minScore));
29
+ if (results.code !== 0) {
30
+ spinner.fail(chalk_1.default.red(`Error ${results.code}: ${results.msg}`));
31
+ return;
32
+ }
33
+ spinner.succeed(chalk_1.default.green('Search completed!'));
34
+ console.log(chalk_1.default.bold('\nSearch Results:'));
35
+ console.log('────────────────────────────────────────────────────────────────────────────────');
36
+ if (results.chunks.length === 0) {
37
+ console.log(chalk_1.default.yellow('No matching chunks found.'));
38
+ }
39
+ results.chunks.forEach((chunk, index) => {
40
+ console.log(chalk_1.default.cyan(`[${index + 1}] Score: ${chunk.score.toFixed(4)}`));
41
+ if (chunk.doc_id)
42
+ console.log(chalk_1.default.dim(`Doc ID: ${chunk.doc_id}`));
43
+ if (chunk.chunk_id)
44
+ console.log(chalk_1.default.dim(`Chunk ID: ${chunk.chunk_id}`));
45
+ console.log(chalk_1.default.green('Content:'));
46
+ console.log(chunk.content);
47
+ console.log('────────────────────────────────────────────────────────────────────────────────');
48
+ });
49
+ }
50
+ catch (error) {
51
+ spinner.fail(chalk_1.default.red('Search failed'));
52
+ console.error(chalk_1.default.red(error.message));
53
+ process.exit(1);
54
+ }
55
+ });
56
+ exports.knowledgeCommand.command('add')
57
+ .description('Add documents to knowledge base')
58
+ .requiredOption('-d, --dataset <name>', 'Dataset name (table) to add to')
59
+ .option('-c, --content <text>', 'Raw text content to add (can be used multiple times)', (value, previous) => previous.concat([value]), [])
60
+ .option('-u, --url <url>', 'Web URL to add (can be used multiple times)', (value, previous) => previous.concat([value]), [])
61
+ .option('--chunk-separator <char>', 'Chunk separator', '\\n')
62
+ .option('--max-tokens <number>', 'Max tokens per chunk', '500')
63
+ .option('--remove-extra-spaces', 'Normalize extra spaces', false)
64
+ .option('--remove-urls-emails', 'Strip URLs and emails', false)
65
+ .option('-H, --header <header>', 'Custom HTTP header (format: "Key: Value" or "Key=Value", can be used multiple times)', (value, previous) => previous.concat([value]), [])
66
+ .option('--verbose', 'Enable verbose logging to print HTTP request details', false)
67
+ .action(async (options) => {
68
+ const spinner = (0, ora_1.default)('Adding documents...').start();
69
+ try {
70
+ const config = new index_1.Config();
71
+ const customHeaders = (0, utils_1.parseHeaders)(options.header);
72
+ const client = new index_1.KnowledgeClient(config, customHeaders, options.verbose);
73
+ const documents = [];
74
+ if (options.content) {
75
+ options.content.forEach((text) => {
76
+ documents.push({
77
+ source: index_1.DataSourceType.TEXT,
78
+ raw_data: text,
79
+ });
80
+ });
81
+ }
82
+ if (options.url) {
83
+ options.url.forEach((url) => {
84
+ documents.push({
85
+ source: index_1.DataSourceType.URL,
86
+ url: url,
87
+ });
88
+ });
89
+ }
90
+ if (documents.length === 0) {
91
+ spinner.fail(chalk_1.default.red('No content or URL provided to add.'));
92
+ return;
93
+ }
94
+ // Handle escaped newlines in chunk separator (e.g. from CLI input)
95
+ const separator = options.chunkSeparator.replace(/\\n/g, '\n');
96
+ const chunkConfig = {
97
+ separator: separator,
98
+ max_tokens: parseInt(options.maxTokens),
99
+ remove_extra_spaces: options.removeExtraSpaces,
100
+ remove_urls_emails: options.removeUrlsEmails,
101
+ };
102
+ const response = await client.addDocuments(documents, options.dataset, chunkConfig);
103
+ if (response.code !== 0) {
104
+ spinner.fail(chalk_1.default.red(`Error ${response.code}: ${response.msg}`));
105
+ return;
106
+ }
107
+ spinner.succeed(chalk_1.default.green('Documents added successfully!'));
108
+ if (response.doc_ids && response.doc_ids.length > 0) {
109
+ console.log(chalk_1.default.cyan(`\nAdded ${response.doc_ids.length} documents.`));
110
+ console.log(chalk_1.default.dim(`Doc IDs: ${response.doc_ids.join(', ')}`));
111
+ }
112
+ }
113
+ catch (error) {
114
+ spinner.fail(chalk_1.default.red('Add documents failed'));
115
+ console.error(chalk_1.default.red(error.message));
116
+ process.exit(1);
117
+ }
118
+ });
119
+ //# sourceMappingURL=knowledge.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"knowledge.js","sourceRoot":"","sources":["../../../src/cli/commands/knowledge.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAoC;AACpC,uCAAsG;AACtG,kDAA0B;AAC1B,8CAAsB;AACtB,oCAAwC;AAE3B,QAAA,gBAAgB,GAAG,IAAI,mBAAO,CAAC,WAAW,CAAC;KACrD,WAAW,CAAC,sBAAsB,CAAC,CAAC;AAEvC,wBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC;KAC/B,WAAW,CAAC,6BAA6B,CAAC;KAC1C,cAAc,CAAC,oBAAoB,EAAE,cAAc,CAAC;KACpD,MAAM,CAAC,sBAAsB,EAAE,kEAAkE,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAc,CAAC;KACjK,MAAM,CAAC,sBAAsB,EAAE,6BAA6B,EAAE,GAAG,CAAC;KAClE,MAAM,CAAC,0BAA0B,EAAE,0BAA0B,EAAE,KAAK,CAAC;KACrE,MAAM,CAAC,uBAAuB,EAAE,sFAAsF,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAc,CAAC;KACtL,MAAM,CAAC,WAAW,EAAE,sDAAsD,EAAE,KAAK,CAAC;KAClF,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,cAAc,CAAC,CAAC,KAAK,EAAE,CAAC;IAE5C,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,cAAM,EAAE,CAAC;QAC5B,MAAM,aAAa,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,IAAI,uBAAe,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAE3E,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CACjC,OAAO,CAAC,KAAK,EACb,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EACxD,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EACtB,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC7B,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,SAAS,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACjE,OAAO;QACT,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAElD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC7C,OAAO,CAAC,GAAG,CAAC,kFAAkF,CAAC,CAAC;QAEhG,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACtC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,YAAY,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,KAAK,CAAC,MAAM;gBAAE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,WAAW,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YACpE,IAAI,KAAK,CAAC,QAAQ;gBAAE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,aAAa,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAC1E,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,kFAAkF,CAAC,CAAC;QAClG,CAAC,CAAC,CAAC;IAEL,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;QACzC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,wBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC;KAC5B,WAAW,CAAC,iCAAiC,CAAC;KAC9C,cAAc,CAAC,sBAAsB,EAAE,gCAAgC,CAAC;KACxE,MAAM,CAAC,sBAAsB,EAAE,sDAAsD,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAc,CAAC;KACrJ,MAAM,CAAC,iBAAiB,EAAE,6CAA6C,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAc,CAAC;KACvI,MAAM,CAAC,0BAA0B,EAAE,iBAAiB,EAAE,KAAK,CAAC;KAC5D,MAAM,CAAC,uBAAuB,EAAE,sBAAsB,EAAE,KAAK,CAAC;KAC9D,MAAM,CAAC,uBAAuB,EAAE,wBAAwB,EAAE,KAAK,CAAC;KAChE,MAAM,CAAC,sBAAsB,EAAE,uBAAuB,EAAE,KAAK,CAAC;KAC9D,MAAM,CAAC,uBAAuB,EAAE,sFAAsF,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAc,CAAC;KACtL,MAAM,CAAC,WAAW,EAAE,sDAAsD,EAAE,KAAK,CAAC;KAClF,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,qBAAqB,CAAC,CAAC,KAAK,EAAE,CAAC;IAEnD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,cAAM,EAAE,CAAC;QAC5B,MAAM,aAAa,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,IAAI,uBAAe,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAE3E,MAAM,SAAS,GAAwB,EAAE,CAAC;QAE1C,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;gBACvC,SAAS,CAAC,IAAI,CAAC;oBACb,MAAM,EAAE,sBAAc,CAAC,IAAI;oBAC3B,QAAQ,EAAE,IAAI;iBACf,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;gBAClC,SAAS,CAAC,IAAI,CAAC;oBACb,MAAM,EAAE,sBAAc,CAAC,GAAG;oBAC1B,GAAG,EAAE,GAAG;iBACT,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC,CAAC;YAC9D,OAAO;QACT,CAAC;QAED,mEAAmE;QACnE,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE/D,MAAM,WAAW,GAAgB;YAC/B,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC;YACvC,mBAAmB,EAAE,OAAO,CAAC,iBAAiB;YAC9C,kBAAkB,EAAE,OAAO,CAAC,gBAAgB;SAC7C,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,YAAY,CACxC,SAAS,EACT,OAAO,CAAC,OAAO,EACf,WAAW,CACZ,CAAC;QAEF,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,SAAS,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACnE,OAAO;QACT,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC;QAE9D,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,WAAW,QAAQ,CAAC,OAAO,CAAC,MAAM,aAAa,CAAC,CAAC,CAAC;YACzE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,YAAY,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC;IAEH,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC"}
package/dist/cli/index.js CHANGED
@@ -7,6 +7,7 @@ const search_1 = require("./commands/search");
7
7
  const voice_1 = require("./commands/voice");
8
8
  const chat_1 = require("./commands/chat");
9
9
  const db_1 = require("./commands/db");
10
+ const knowledge_1 = require("./commands/knowledge");
10
11
  const program = new commander_1.Command();
11
12
  program
12
13
  .name('coze-coding-ai')
@@ -19,5 +20,6 @@ program.addCommand(voice_1.ttsCommand);
19
20
  program.addCommand(voice_1.asrCommand);
20
21
  program.addCommand(chat_1.chatCommand);
21
22
  program.addCommand(db_1.dbCommand);
23
+ program.addCommand(knowledge_1.knowledgeCommand);
22
24
  program.parse(process.argv);
23
25
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";;AAAA,yCAAoC;AACpC,4CAAgD;AAChD,4CAAgD;AAChD,8CAAkD;AAClD,4CAA0D;AAC1D,0CAA8C;AAC9C,sCAA0C;AAE1C,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,gBAAgB,CAAC;KACtB,WAAW,CAAC,oGAAoG,CAAC;KACjH,OAAO,CAAC,OAAO,CAAC,CAAC;AACpB,OAAO,CAAC,UAAU,CAAC,oBAAY,CAAC,CAAC;AACjC,OAAO,CAAC,UAAU,CAAC,oBAAY,CAAC,CAAC;AACjC,OAAO,CAAC,UAAU,CAAC,sBAAa,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,kBAAU,CAAC,CAAC;AAC/B,OAAO,CAAC,UAAU,CAAC,kBAAU,CAAC,CAAC;AAC/B,OAAO,CAAC,UAAU,CAAC,kBAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,cAAS,CAAC,CAAC;AAE9B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";;AAAA,yCAAoC;AACpC,4CAAgD;AAChD,4CAAgD;AAChD,8CAAkD;AAClD,4CAA0D;AAC1D,0CAA8C;AAC9C,sCAA0C;AAC1C,oDAAwD;AAExD,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,gBAAgB,CAAC;KACtB,WAAW,CAAC,oGAAoG,CAAC;KACjH,OAAO,CAAC,OAAO,CAAC,CAAC;AACpB,OAAO,CAAC,UAAU,CAAC,oBAAY,CAAC,CAAC;AACjC,OAAO,CAAC,UAAU,CAAC,oBAAY,CAAC,CAAC;AACjC,OAAO,CAAC,UAAU,CAAC,sBAAa,CAAC,CAAC;AAClC,OAAO,CAAC,UAAU,CAAC,kBAAU,CAAC,CAAC;AAC/B,OAAO,CAAC,UAAU,CAAC,kBAAU,CAAC,CAAC;AAC/B,OAAO,CAAC,UAAU,CAAC,kBAAW,CAAC,CAAC;AAChC,OAAO,CAAC,UAAU,CAAC,cAAS,CAAC,CAAC;AAC9B,OAAO,CAAC,UAAU,CAAC,4BAAgB,CAAC,CAAC;AAErC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
package/dist/index.d.ts CHANGED
@@ -4,6 +4,7 @@ export * from './search';
4
4
  export * from './voice';
5
5
  export * from './video';
6
6
  export * from './llm';
7
+ export * from './knowledge';
7
8
  export * from './database';
8
9
  export * from './s3';
9
10
  export { VERSION } from './version';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,MAAM,CAAC;AACrB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,MAAM,CAAC;AACrB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
package/dist/index.js CHANGED
@@ -21,6 +21,7 @@ __exportStar(require("./search"), exports);
21
21
  __exportStar(require("./voice"), exports);
22
22
  __exportStar(require("./video"), exports);
23
23
  __exportStar(require("./llm"), exports);
24
+ __exportStar(require("./knowledge"), exports);
24
25
  __exportStar(require("./database"), exports);
25
26
  __exportStar(require("./s3"), exports);
26
27
  var version_1 = require("./version");
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,0CAAwB;AACxB,2CAAyB;AACzB,0CAAwB;AACxB,0CAAwB;AACxB,wCAAsB;AACtB,6CAA2B;AAC3B,uCAAqB;AACrB,qCAAoC;AAA3B,kGAAA,OAAO,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,0CAAwB;AACxB,2CAAyB;AACzB,0CAAwB;AACxB,0CAAwB;AACxB,wCAAsB;AACtB,8CAA4B;AAC5B,6CAA2B;AAC3B,uCAAqB;AACrB,qCAAoC;AAA3B,kGAAA,OAAO,OAAA"}
@@ -0,0 +1,10 @@
1
+ import { BaseClient } from '../core/client';
2
+ import { Config } from '../core/config';
3
+ import { ChunkConfig, KnowledgeDocument, KnowledgeInsertResponse, KnowledgeSearchResponse } from './models';
4
+ export declare class KnowledgeClient extends BaseClient {
5
+ private baseUrl;
6
+ constructor(config?: Config, customHeaders?: Record<string, string>, verbose?: boolean);
7
+ search(query: string, tableNames?: string[], topK?: number, minScore?: number, extraHeaders?: Record<string, string>): Promise<KnowledgeSearchResponse>;
8
+ addDocuments(documents: KnowledgeDocument[], tableName: string, chunkConfig?: ChunkConfig, extraHeaders?: Record<string, string>): Promise<KnowledgeInsertResponse>;
9
+ }
10
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/knowledge/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EACL,WAAW,EAEX,iBAAiB,EACjB,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,UAAU,CAAC;AAElB,qBAAa,eAAgB,SAAQ,UAAU;IAC7C,OAAO,CAAC,OAAO,CAAS;gBAGtB,MAAM,CAAC,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACtC,OAAO,GAAE,OAAe;IAapB,MAAM,CACV,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,EAAE,EACrB,IAAI,GAAE,MAAU,EAChB,QAAQ,GAAE,MAAY,EACtB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,OAAO,CAAC,uBAAuB,CAAC;IA0C7B,YAAY,CAChB,SAAS,EAAE,iBAAiB,EAAE,EAC9B,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,WAAW,EACzB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACpC,OAAO,CAAC,uBAAuB,CAAC;CAuCpC"}
@@ -0,0 +1,73 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.KnowledgeClient = void 0;
4
+ const client_1 = require("../core/client");
5
+ class KnowledgeClient extends client_1.BaseClient {
6
+ constructor(config, customHeaders, verbose = false) {
7
+ super(config, customHeaders, verbose);
8
+ // Use COZE_INTEGRATION_BASE_URL as endpoint, defaults to config.baseUrl
9
+ this.baseUrl = this.config.baseUrl;
10
+ // Add default PPE headers for testing
11
+ Object.assign(this.axiosInstance.defaults.headers.common, {
12
+ 'x-tt-env': 'ppe_coze_knowledge',
13
+ 'x-use-ppe': '1',
14
+ });
15
+ }
16
+ async search(query, tableNames, topK = 5, minScore = 0.0, extraHeaders) {
17
+ const payload = {
18
+ query,
19
+ top_k: topK,
20
+ min_score: minScore,
21
+ };
22
+ if (tableNames) {
23
+ payload.dataset = tableNames;
24
+ }
25
+ const url = `${this.baseUrl}/v1/knowledge_base/recall`;
26
+ const headers = { ...extraHeaders };
27
+ if (this.config.apiKey) {
28
+ headers['x-coze-token'] = `Bearer ${this.config.apiKey}`;
29
+ }
30
+ const response = await this.request('POST', url, payload, { headers });
31
+ // Response structure: { "data": [ ... ], "code": 0, "msg": "" }
32
+ const dataList = response.data || [];
33
+ const chunks = dataList.map((item) => ({
34
+ content: item.slice || '',
35
+ score: item.score || 0.0,
36
+ chunk_id: item.chunk_id,
37
+ doc_id: item.doc_id,
38
+ }));
39
+ return {
40
+ chunks,
41
+ code: response.code || 0,
42
+ msg: response.msg || '',
43
+ };
44
+ }
45
+ async addDocuments(documents, tableName, chunkConfig, extraHeaders) {
46
+ const payload = {
47
+ dataset: tableName,
48
+ data: documents, // TypeScript automatically serializes objects, so no need for explicit to_api_format equivalent if keys match
49
+ };
50
+ if (chunkConfig) {
51
+ // Remove undefined fields
52
+ const cleanChunkConfig = Object.fromEntries(Object.entries(chunkConfig).filter(([_, v]) => v !== undefined));
53
+ payload.chunk_config = cleanChunkConfig;
54
+ }
55
+ const url = `${this.baseUrl}/v1/knowledge_base/batch_import`;
56
+ const headers = { ...extraHeaders };
57
+ if (this.config.apiKey) {
58
+ headers['x-coze-token'] = `Bearer ${this.config.apiKey}`;
59
+ }
60
+ const response = await this.request('POST', url, payload, { headers });
61
+ let msg = response.msg || '';
62
+ if (response.code === 0) {
63
+ msg = "成功!文档正在异步导入中,请稍候。您可以查看数据库中的 'knowledge' schema 来验证导入状态。";
64
+ }
65
+ return {
66
+ doc_ids: response.doc_ids,
67
+ code: response.code || 0,
68
+ msg: msg,
69
+ };
70
+ }
71
+ }
72
+ exports.KnowledgeClient = KnowledgeClient;
73
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/knowledge/client.ts"],"names":[],"mappings":";;;AAAA,2CAA4C;AAU5C,MAAa,eAAgB,SAAQ,mBAAU;IAG7C,YACE,MAAe,EACf,aAAsC,EACtC,UAAmB,KAAK;QAExB,KAAK,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QACtC,wEAAwE;QACxE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;QAEnC,sCAAsC;QACtC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;YACxD,UAAU,EAAE,oBAAoB;YAChC,WAAW,EAAE,GAAG;SACjB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CACV,KAAa,EACb,UAAqB,EACrB,OAAe,CAAC,EAChB,WAAmB,GAAG,EACtB,YAAqC;QAErC,MAAM,OAAO,GAAQ;YACnB,KAAK;YACL,KAAK,EAAE,IAAI;YACX,SAAS,EAAE,QAAQ;SACpB,CAAC;QAEF,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC;QAC/B,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,2BAA2B,CAAC;QAEvD,MAAM,OAAO,GAA2B,EAAE,GAAG,YAAY,EAAE,CAAC;QAC5D,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,cAAc,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,MAAM,EACN,GAAG,EACH,OAAO,EACP,EAAE,OAAO,EAAE,CACZ,CAAC;QAEF,gEAAgE;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;QAErC,MAAM,MAAM,GAAqB,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,CAAC;YAC5D,OAAO,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,GAAG;YACxB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC,CAAC,CAAC;QAEJ,OAAO;YACL,MAAM;YACN,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC;YACxB,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,EAAE;SACxB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,SAA8B,EAC9B,SAAiB,EACjB,WAAyB,EACzB,YAAqC;QAErC,MAAM,OAAO,GAAQ;YACnB,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,SAAS,EAAE,8GAA8G;SAChI,CAAC;QAEF,IAAI,WAAW,EAAE,CAAC;YAChB,0BAA0B;YAC1B,MAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,CACzC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAChE,CAAC;YACF,OAAO,CAAC,YAAY,GAAG,gBAAgB,CAAC;QAC1C,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,iCAAiC,CAAC;QAE7D,MAAM,OAAO,GAA2B,EAAE,GAAG,YAAY,EAAE,CAAC;QAC5D,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,cAAc,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,MAAM,EACN,GAAG,EACH,OAAO,EACP,EAAE,OAAO,EAAE,CACZ,CAAC;QAEF,IAAI,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC;QAC7B,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACxB,GAAG,GAAG,yDAAyD,CAAC;QAClE,CAAC;QAED,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC;YACxB,GAAG,EAAE,GAAG;SACT,CAAC;IACJ,CAAC;CACF;AA/GD,0CA+GC"}
@@ -0,0 +1,3 @@
1
+ export * from './models';
2
+ export * from './client';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/knowledge/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./models"), exports);
18
+ __exportStar(require("./client"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/knowledge/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,2CAAyB"}
@@ -0,0 +1,34 @@
1
+ export declare enum DataSourceType {
2
+ TEXT = 0,
3
+ URL = 1,
4
+ URI = 2
5
+ }
6
+ export interface ChunkConfig {
7
+ separator: string;
8
+ max_tokens: number;
9
+ remove_extra_spaces?: boolean;
10
+ remove_urls_emails?: boolean;
11
+ }
12
+ export interface KnowledgeDocument {
13
+ source: DataSourceType;
14
+ raw_data?: string;
15
+ uri?: string;
16
+ url?: string;
17
+ }
18
+ export interface KnowledgeChunk {
19
+ content: string;
20
+ score: number;
21
+ chunk_id?: string;
22
+ doc_id?: string;
23
+ }
24
+ export interface KnowledgeSearchResponse {
25
+ chunks: KnowledgeChunk[];
26
+ code: number;
27
+ msg: string;
28
+ }
29
+ export interface KnowledgeInsertResponse {
30
+ doc_ids?: string[];
31
+ code: number;
32
+ msg: string;
33
+ }
34
+ //# sourceMappingURL=models.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/knowledge/models.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,IAAI,IAAI;IACR,GAAG,IAAI;IACP,GAAG,IAAI;CACR;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb"}
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DataSourceType = void 0;
4
+ var DataSourceType;
5
+ (function (DataSourceType) {
6
+ DataSourceType[DataSourceType["TEXT"] = 0] = "TEXT";
7
+ DataSourceType[DataSourceType["URL"] = 1] = "URL";
8
+ DataSourceType[DataSourceType["URI"] = 2] = "URI";
9
+ })(DataSourceType || (exports.DataSourceType = DataSourceType = {}));
10
+ //# sourceMappingURL=models.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/knowledge/models.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mDAAQ,CAAA;IACR,iDAAO,CAAA;IACP,iDAAO,CAAA;AACT,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "coze-coding-dev-sdk",
3
- "version": "0.5.5",
3
+ "version": "0.5.6",
4
4
  "description": "Coze Coding Dev SDK - 优雅的多功能 AI SDK,支持图片生成、视频生成、语音合成、语音识别、大语言模型和联网搜索",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",