@thanh01.pmt/research-kit 1.0.0 → 1.1.1
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.
- package/LICENSE +21 -0
- package/README.md +213 -0
- package/dist/academic/index.cjs +332 -127
- package/dist/academic/index.cjs.map +1 -1
- package/dist/academic/index.d.cts +3 -3
- package/dist/academic/index.d.ts +3 -3
- package/dist/academic/index.js +2 -2
- package/dist/{catalogBuilder-8A-Dg_A-.d.ts → catalogBuilder-CmmQzUnf.d.ts} +11 -3
- package/dist/{catalogBuilder-feU79wQQ.d.cts → catalogBuilder-DgXYxL2F.d.cts} +11 -3
- package/dist/chunk-2JEVBCIF.js +3 -0
- package/dist/{chunk-KGCDYFFD.js.map → chunk-2JEVBCIF.js.map} +1 -1
- package/dist/chunk-2XIEWCUE.js +244 -0
- package/dist/chunk-2XIEWCUE.js.map +1 -0
- package/dist/chunk-AUGVVZTL.js +514 -0
- package/dist/chunk-AUGVVZTL.js.map +1 -0
- package/dist/chunk-DOXSPRSP.js +559 -0
- package/dist/chunk-DOXSPRSP.js.map +1 -0
- package/dist/chunk-GKF3NDEX.js +162 -0
- package/dist/chunk-GKF3NDEX.js.map +1 -0
- package/dist/chunk-J3VCGH7Z.js +3 -0
- package/dist/chunk-J3VCGH7Z.js.map +1 -0
- package/dist/{chunk-67V2GJGK.js → chunk-J7XKDMGL.js} +7 -5
- package/dist/chunk-J7XKDMGL.js.map +1 -0
- package/dist/chunk-KAFQVI2R.js +333 -0
- package/dist/chunk-KAFQVI2R.js.map +1 -0
- package/dist/chunk-XIF5YNI7.js +799 -0
- package/dist/chunk-XIF5YNI7.js.map +1 -0
- package/dist/config/index.cjs +5 -3
- package/dist/config/index.cjs.map +1 -1
- package/dist/config/index.d.cts +1 -1
- package/dist/config/index.d.ts +1 -1
- package/dist/config/index.js +1 -1
- package/dist/evidence/index.cjs +337 -21
- package/dist/evidence/index.cjs.map +1 -1
- package/dist/evidence/index.d.cts +44 -7
- package/dist/evidence/index.d.ts +44 -7
- package/dist/evidence/index.js +3 -2
- package/dist/harvester/index.cjs +805 -64
- package/dist/harvester/index.cjs.map +1 -1
- package/dist/harvester/index.d.cts +79 -8
- package/dist/harvester/index.d.ts +79 -8
- package/dist/harvester/index.js +3 -2
- package/dist/{index-BU5n1ip_.d.ts → index-t8pahlJ4.d.cts} +104 -15
- package/dist/{index-BU5n1ip_.d.cts → index-t8pahlJ4.d.ts} +104 -15
- package/dist/index.cjs +2001 -252
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +156 -8
- package/dist/index.d.ts +156 -8
- package/dist/index.js +237 -8
- package/dist/index.js.map +1 -1
- package/dist/literatureReview-BTPFe7eb.d.cts +64 -0
- package/dist/literatureReview-hGbfrBmw.d.ts +64 -0
- package/dist/pipeline/index.cjs +1570 -241
- package/dist/pipeline/index.cjs.map +1 -1
- package/dist/pipeline/index.d.cts +49 -9
- package/dist/pipeline/index.d.ts +49 -9
- package/dist/pipeline/index.js +5 -4
- package/dist/webScraper-BhiQ8s9x.d.ts +68 -0
- package/dist/webScraper-D9Ldus9p.d.cts +68 -0
- package/package.json +8 -9
- package/dist/chunk-47L7ZHMY.js +0 -316
- package/dist/chunk-47L7ZHMY.js.map +0 -1
- package/dist/chunk-63X2HPCI.js +0 -47
- package/dist/chunk-63X2HPCI.js.map +0 -1
- package/dist/chunk-67V2GJGK.js.map +0 -1
- package/dist/chunk-6Q2XCUG7.js +0 -40
- package/dist/chunk-6Q2XCUG7.js.map +0 -1
- package/dist/chunk-KGCDYFFD.js +0 -3
- package/dist/chunk-MHAYD555.js +0 -239
- package/dist/chunk-MHAYD555.js.map +0 -1
- package/dist/chunk-MPLDSHFM.js +0 -396
- package/dist/chunk-MPLDSHFM.js.map +0 -1
- package/dist/chunk-QZNLB5X4.js +0 -65
- package/dist/chunk-QZNLB5X4.js.map +0 -1
- package/dist/literatureReview-C4AgVljZ.d.ts +0 -43
- package/dist/literatureReview-Dlods4Aw.d.cts +0 -43
- package/dist/webScraper-pKzdXhfI.d.ts +0 -46
- package/dist/webScraper-yBcYOHoL.d.cts +0 -46
|
@@ -46,27 +46,68 @@ interface AcademicSearchOptions {
|
|
|
46
46
|
yearRange?: string;
|
|
47
47
|
fieldsOfStudy?: string[];
|
|
48
48
|
apiKey?: string;
|
|
49
|
+
allowEnvFallback?: boolean;
|
|
50
|
+
includeArxivFallback?: boolean;
|
|
49
51
|
customAdapter?: CustomAcademicSearchAdapter;
|
|
50
52
|
}
|
|
51
53
|
/**
|
|
52
|
-
*
|
|
54
|
+
* Reconstructs plain-text abstract from OpenAlex's `abstract_inverted_index` object (`{ word: [pos1, pos2] }`).
|
|
55
|
+
*/
|
|
56
|
+
declare function reconstructOpenAlexAbstract(invertedIndex: Record<string, number[]> | undefined | null): string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* Semantic Scholar, OpenAlex & ArXiv Academic Search Engine with Custom Adapter Support
|
|
53
59
|
*/
|
|
54
60
|
declare class AcademicSearchEngine {
|
|
55
61
|
private apiKey?;
|
|
62
|
+
private allowEnvFallback;
|
|
56
63
|
private customAdapter?;
|
|
64
|
+
private arxivEngine;
|
|
57
65
|
constructor(options?: {
|
|
58
66
|
apiKey?: string;
|
|
67
|
+
allowEnvFallback?: boolean;
|
|
59
68
|
customAdapter?: CustomAcademicSearchAdapter;
|
|
60
69
|
} | string);
|
|
61
70
|
setCustomAdapter(adapter: CustomAcademicSearchAdapter): void;
|
|
71
|
+
setApiKey(apiKey?: string): void;
|
|
62
72
|
/**
|
|
63
|
-
* Search academic papers across Semantic Scholar with OpenAlex fallback or Custom Adapter
|
|
73
|
+
* Search academic papers across Semantic Scholar with OpenAlex and ArXiv fallback or Custom Adapter
|
|
64
74
|
*/
|
|
65
75
|
searchPapers(query: string, options?: AcademicSearchOptions): Promise<AcademicPaper[]>;
|
|
66
76
|
}
|
|
67
77
|
|
|
68
|
-
type SearchProviderType = 'tavily' | 'exa' | 'searxng' | 'duckduckgo' | 'semantic_scholar' | 'openalex' | 'arxiv' | 'custom';
|
|
69
|
-
type CrawlerProviderType = 'jina' | 'crawl4ai' | 'defuddle' | 'direct' | 'custom';
|
|
78
|
+
type SearchProviderType = 'tavily' | 'exa' | 'serper' | 'searxng' | 'duckduckgo' | 'semantic_scholar' | 'openalex' | 'arxiv' | 'custom';
|
|
79
|
+
type CrawlerProviderType = 'jina' | 'crawl4ai' | 'youtube' | 'defuddle' | 'direct' | 'custom';
|
|
80
|
+
interface ResearchApiKeys {
|
|
81
|
+
tavily?: string;
|
|
82
|
+
exa?: string;
|
|
83
|
+
jina?: string;
|
|
84
|
+
serper?: string;
|
|
85
|
+
semanticScholar?: string;
|
|
86
|
+
}
|
|
87
|
+
interface CourseResearchContext {
|
|
88
|
+
courseTitle?: string;
|
|
89
|
+
positioning?: string;
|
|
90
|
+
problemStatement?: string;
|
|
91
|
+
ageBand?: [number, number];
|
|
92
|
+
entryLevel?: 'beginner' | 'intermediate' | 'advanced' | string;
|
|
93
|
+
hardwarePlatform?: string;
|
|
94
|
+
softwareEnv?: string;
|
|
95
|
+
totalSessions?: number;
|
|
96
|
+
sessionDurationMinutes?: number;
|
|
97
|
+
inScopeTopics?: string[];
|
|
98
|
+
outOfScopeTopics?: string[];
|
|
99
|
+
instructionLanguage?: 'vi' | 'en' | 'bilingual' | string;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Universal LLM callback injected by the host application (e.g. smart-curriculum or curriculum-kit).
|
|
103
|
+
* Keeps research-kit 100% free of vendor SDK lock-in while enabling deep semantic synthesis.
|
|
104
|
+
*/
|
|
105
|
+
type LlmTextFn = (prompt: string, options?: {
|
|
106
|
+
system?: string;
|
|
107
|
+
temperature?: number;
|
|
108
|
+
maxTokens?: number;
|
|
109
|
+
jsonMode?: boolean;
|
|
110
|
+
}) => Promise<string>;
|
|
70
111
|
interface CustomSearchAdapter {
|
|
71
112
|
search(query: string, options?: {
|
|
72
113
|
limit?: number;
|
|
@@ -92,43 +133,87 @@ interface CustomAcademicSearchAdapter {
|
|
|
92
133
|
yearRange?: string;
|
|
93
134
|
}): Promise<AcademicPaper[]>;
|
|
94
135
|
}
|
|
136
|
+
interface ExtractedConceptNode {
|
|
137
|
+
id: string;
|
|
138
|
+
term: string;
|
|
139
|
+
termVi?: string;
|
|
140
|
+
termEn?: string;
|
|
141
|
+
category: 'core_concept' | 'api_syntax' | 'hardware_component' | 'pedagogical_pattern';
|
|
142
|
+
marrLayer: 'ULO' | 'CIO' | 'SIO';
|
|
143
|
+
bloomLevel: 'remember' | 'understand' | 'apply' | 'analyze' | 'evaluate' | 'create';
|
|
144
|
+
salienceScore: number;
|
|
145
|
+
definition: string;
|
|
146
|
+
prerequisites: string[];
|
|
147
|
+
sourceIds: string[];
|
|
148
|
+
}
|
|
149
|
+
interface SynthesizedResearchInsights {
|
|
150
|
+
executiveSummary: string;
|
|
151
|
+
keyTakeaways: string[];
|
|
152
|
+
commonMisconceptionsAndPitfalls: string[];
|
|
153
|
+
recommendedExemplars: string[];
|
|
154
|
+
extractedConcepts?: ExtractedConceptNode[];
|
|
155
|
+
}
|
|
156
|
+
interface CustomSynthesizerAdapter {
|
|
157
|
+
synthesize(input: {
|
|
158
|
+
topic: string;
|
|
159
|
+
domain: string;
|
|
160
|
+
context?: CourseResearchContext;
|
|
161
|
+
excerpts: Array<{
|
|
162
|
+
resourceId: string;
|
|
163
|
+
title: string;
|
|
164
|
+
url: string;
|
|
165
|
+
excerpt: string;
|
|
166
|
+
codeSnippets: string[];
|
|
167
|
+
}>;
|
|
168
|
+
}): Promise<SynthesizedResearchInsights>;
|
|
169
|
+
}
|
|
95
170
|
declare const ResearchConfigSchema: z.ZodObject<{
|
|
96
171
|
search: z.ZodDefault<z.ZodObject<{
|
|
97
|
-
preferredProvider: z.ZodDefault<z.ZodEnum<["tavily", "exa", "searxng", "duckduckgo", "semantic_scholar", "openalex", "arxiv", "custom"]>>;
|
|
172
|
+
preferredProvider: z.ZodDefault<z.ZodEnum<["tavily", "exa", "serper", "searxng", "duckduckgo", "semantic_scholar", "openalex", "arxiv", "custom"]>>;
|
|
98
173
|
fallbackChain: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
99
174
|
apiKeys: z.ZodDefault<z.ZodObject<{
|
|
100
175
|
tavily: z.ZodOptional<z.ZodString>;
|
|
101
176
|
exa: z.ZodOptional<z.ZodString>;
|
|
177
|
+
jina: z.ZodOptional<z.ZodString>;
|
|
178
|
+
serper: z.ZodOptional<z.ZodString>;
|
|
102
179
|
semanticScholar: z.ZodOptional<z.ZodString>;
|
|
103
180
|
}, "strip", z.ZodTypeAny, {
|
|
104
181
|
tavily?: string | undefined;
|
|
105
182
|
exa?: string | undefined;
|
|
183
|
+
serper?: string | undefined;
|
|
184
|
+
jina?: string | undefined;
|
|
106
185
|
semanticScholar?: string | undefined;
|
|
107
186
|
}, {
|
|
108
187
|
tavily?: string | undefined;
|
|
109
188
|
exa?: string | undefined;
|
|
189
|
+
serper?: string | undefined;
|
|
190
|
+
jina?: string | undefined;
|
|
110
191
|
semanticScholar?: string | undefined;
|
|
111
192
|
}>>;
|
|
112
193
|
searxngHost: z.ZodOptional<z.ZodString>;
|
|
113
194
|
timeoutMs: z.ZodDefault<z.ZodNumber>;
|
|
114
195
|
maxResultsPerQuery: z.ZodDefault<z.ZodNumber>;
|
|
115
196
|
}, "strip", z.ZodTypeAny, {
|
|
116
|
-
preferredProvider: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
197
|
+
preferredProvider: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
117
198
|
fallbackChain: string[];
|
|
118
199
|
apiKeys: {
|
|
119
200
|
tavily?: string | undefined;
|
|
120
201
|
exa?: string | undefined;
|
|
202
|
+
serper?: string | undefined;
|
|
203
|
+
jina?: string | undefined;
|
|
121
204
|
semanticScholar?: string | undefined;
|
|
122
205
|
};
|
|
123
206
|
timeoutMs: number;
|
|
124
207
|
maxResultsPerQuery: number;
|
|
125
208
|
searxngHost?: string | undefined;
|
|
126
209
|
}, {
|
|
127
|
-
preferredProvider?: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
210
|
+
preferredProvider?: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
128
211
|
fallbackChain?: string[] | undefined;
|
|
129
212
|
apiKeys?: {
|
|
130
213
|
tavily?: string | undefined;
|
|
131
214
|
exa?: string | undefined;
|
|
215
|
+
serper?: string | undefined;
|
|
216
|
+
jina?: string | undefined;
|
|
132
217
|
semanticScholar?: string | undefined;
|
|
133
218
|
} | undefined;
|
|
134
219
|
searxngHost?: string | undefined;
|
|
@@ -136,19 +221,19 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
136
221
|
maxResultsPerQuery?: number | undefined;
|
|
137
222
|
}>>;
|
|
138
223
|
crawler: z.ZodDefault<z.ZodObject<{
|
|
139
|
-
preferredProvider: z.ZodDefault<z.ZodEnum<["jina", "crawl4ai", "defuddle", "direct", "custom"]>>;
|
|
224
|
+
preferredProvider: z.ZodDefault<z.ZodEnum<["jina", "crawl4ai", "youtube", "defuddle", "direct", "custom"]>>;
|
|
140
225
|
fallbackChain: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
141
226
|
crawl4aiHost: z.ZodDefault<z.ZodString>;
|
|
142
227
|
timeoutMs: z.ZodDefault<z.ZodNumber>;
|
|
143
228
|
maxContentLength: z.ZodDefault<z.ZodNumber>;
|
|
144
229
|
}, "strip", z.ZodTypeAny, {
|
|
145
|
-
preferredProvider: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct";
|
|
230
|
+
preferredProvider: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct";
|
|
146
231
|
fallbackChain: string[];
|
|
147
232
|
timeoutMs: number;
|
|
148
233
|
crawl4aiHost: string;
|
|
149
234
|
maxContentLength: number;
|
|
150
235
|
}, {
|
|
151
|
-
preferredProvider?: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct" | undefined;
|
|
236
|
+
preferredProvider?: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct" | undefined;
|
|
152
237
|
fallbackChain?: string[] | undefined;
|
|
153
238
|
timeoutMs?: number | undefined;
|
|
154
239
|
crawl4aiHost?: string | undefined;
|
|
@@ -169,11 +254,13 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
169
254
|
}>>;
|
|
170
255
|
}, "strip", z.ZodTypeAny, {
|
|
171
256
|
search: {
|
|
172
|
-
preferredProvider: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
257
|
+
preferredProvider: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
173
258
|
fallbackChain: string[];
|
|
174
259
|
apiKeys: {
|
|
175
260
|
tavily?: string | undefined;
|
|
176
261
|
exa?: string | undefined;
|
|
262
|
+
serper?: string | undefined;
|
|
263
|
+
jina?: string | undefined;
|
|
177
264
|
semanticScholar?: string | undefined;
|
|
178
265
|
};
|
|
179
266
|
timeoutMs: number;
|
|
@@ -181,7 +268,7 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
181
268
|
searxngHost?: string | undefined;
|
|
182
269
|
};
|
|
183
270
|
crawler: {
|
|
184
|
-
preferredProvider: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct";
|
|
271
|
+
preferredProvider: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct";
|
|
185
272
|
fallbackChain: string[];
|
|
186
273
|
timeoutMs: number;
|
|
187
274
|
crawl4aiHost: string;
|
|
@@ -194,11 +281,13 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
194
281
|
};
|
|
195
282
|
}, {
|
|
196
283
|
search?: {
|
|
197
|
-
preferredProvider?: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
284
|
+
preferredProvider?: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
198
285
|
fallbackChain?: string[] | undefined;
|
|
199
286
|
apiKeys?: {
|
|
200
287
|
tavily?: string | undefined;
|
|
201
288
|
exa?: string | undefined;
|
|
289
|
+
serper?: string | undefined;
|
|
290
|
+
jina?: string | undefined;
|
|
202
291
|
semanticScholar?: string | undefined;
|
|
203
292
|
} | undefined;
|
|
204
293
|
searxngHost?: string | undefined;
|
|
@@ -206,7 +295,7 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
206
295
|
maxResultsPerQuery?: number | undefined;
|
|
207
296
|
} | undefined;
|
|
208
297
|
crawler?: {
|
|
209
|
-
preferredProvider?: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct" | undefined;
|
|
298
|
+
preferredProvider?: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct" | undefined;
|
|
210
299
|
fallbackChain?: string[] | undefined;
|
|
211
300
|
timeoutMs?: number | undefined;
|
|
212
301
|
crawl4aiHost?: string | undefined;
|
|
@@ -221,4 +310,4 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
221
310
|
type ResearchConfig = z.infer<typeof ResearchConfigSchema>;
|
|
222
311
|
declare const DEFAULT_RESEARCH_CONFIG: ResearchConfig;
|
|
223
312
|
|
|
224
|
-
export {
|
|
313
|
+
export { type AcademicPaper as A, type CourseResearchContext as C, DEFAULT_RESEARCH_CONFIG as D, type ExtractedConceptNode as E, type LlmTextFn as L, type ResearchApiKeys as R, type SearchProviderType as S, type CustomSearchAdapter as a, type CustomCrawlerAdapter as b, type CustomAcademicSearchAdapter as c, type CustomSynthesizerAdapter as d, type CrawlerProviderType as e, type SynthesizedResearchInsights as f, ResearchConfigSchema as g, type ResearchConfig as h, AcademicPaperSchema as i, type AcademicSearchOptions as j, AcademicSearchEngine as k, reconstructOpenAlexAbstract as r };
|
|
@@ -46,27 +46,68 @@ interface AcademicSearchOptions {
|
|
|
46
46
|
yearRange?: string;
|
|
47
47
|
fieldsOfStudy?: string[];
|
|
48
48
|
apiKey?: string;
|
|
49
|
+
allowEnvFallback?: boolean;
|
|
50
|
+
includeArxivFallback?: boolean;
|
|
49
51
|
customAdapter?: CustomAcademicSearchAdapter;
|
|
50
52
|
}
|
|
51
53
|
/**
|
|
52
|
-
*
|
|
54
|
+
* Reconstructs plain-text abstract from OpenAlex's `abstract_inverted_index` object (`{ word: [pos1, pos2] }`).
|
|
55
|
+
*/
|
|
56
|
+
declare function reconstructOpenAlexAbstract(invertedIndex: Record<string, number[]> | undefined | null): string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* Semantic Scholar, OpenAlex & ArXiv Academic Search Engine with Custom Adapter Support
|
|
53
59
|
*/
|
|
54
60
|
declare class AcademicSearchEngine {
|
|
55
61
|
private apiKey?;
|
|
62
|
+
private allowEnvFallback;
|
|
56
63
|
private customAdapter?;
|
|
64
|
+
private arxivEngine;
|
|
57
65
|
constructor(options?: {
|
|
58
66
|
apiKey?: string;
|
|
67
|
+
allowEnvFallback?: boolean;
|
|
59
68
|
customAdapter?: CustomAcademicSearchAdapter;
|
|
60
69
|
} | string);
|
|
61
70
|
setCustomAdapter(adapter: CustomAcademicSearchAdapter): void;
|
|
71
|
+
setApiKey(apiKey?: string): void;
|
|
62
72
|
/**
|
|
63
|
-
* Search academic papers across Semantic Scholar with OpenAlex fallback or Custom Adapter
|
|
73
|
+
* Search academic papers across Semantic Scholar with OpenAlex and ArXiv fallback or Custom Adapter
|
|
64
74
|
*/
|
|
65
75
|
searchPapers(query: string, options?: AcademicSearchOptions): Promise<AcademicPaper[]>;
|
|
66
76
|
}
|
|
67
77
|
|
|
68
|
-
type SearchProviderType = 'tavily' | 'exa' | 'searxng' | 'duckduckgo' | 'semantic_scholar' | 'openalex' | 'arxiv' | 'custom';
|
|
69
|
-
type CrawlerProviderType = 'jina' | 'crawl4ai' | 'defuddle' | 'direct' | 'custom';
|
|
78
|
+
type SearchProviderType = 'tavily' | 'exa' | 'serper' | 'searxng' | 'duckduckgo' | 'semantic_scholar' | 'openalex' | 'arxiv' | 'custom';
|
|
79
|
+
type CrawlerProviderType = 'jina' | 'crawl4ai' | 'youtube' | 'defuddle' | 'direct' | 'custom';
|
|
80
|
+
interface ResearchApiKeys {
|
|
81
|
+
tavily?: string;
|
|
82
|
+
exa?: string;
|
|
83
|
+
jina?: string;
|
|
84
|
+
serper?: string;
|
|
85
|
+
semanticScholar?: string;
|
|
86
|
+
}
|
|
87
|
+
interface CourseResearchContext {
|
|
88
|
+
courseTitle?: string;
|
|
89
|
+
positioning?: string;
|
|
90
|
+
problemStatement?: string;
|
|
91
|
+
ageBand?: [number, number];
|
|
92
|
+
entryLevel?: 'beginner' | 'intermediate' | 'advanced' | string;
|
|
93
|
+
hardwarePlatform?: string;
|
|
94
|
+
softwareEnv?: string;
|
|
95
|
+
totalSessions?: number;
|
|
96
|
+
sessionDurationMinutes?: number;
|
|
97
|
+
inScopeTopics?: string[];
|
|
98
|
+
outOfScopeTopics?: string[];
|
|
99
|
+
instructionLanguage?: 'vi' | 'en' | 'bilingual' | string;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Universal LLM callback injected by the host application (e.g. smart-curriculum or curriculum-kit).
|
|
103
|
+
* Keeps research-kit 100% free of vendor SDK lock-in while enabling deep semantic synthesis.
|
|
104
|
+
*/
|
|
105
|
+
type LlmTextFn = (prompt: string, options?: {
|
|
106
|
+
system?: string;
|
|
107
|
+
temperature?: number;
|
|
108
|
+
maxTokens?: number;
|
|
109
|
+
jsonMode?: boolean;
|
|
110
|
+
}) => Promise<string>;
|
|
70
111
|
interface CustomSearchAdapter {
|
|
71
112
|
search(query: string, options?: {
|
|
72
113
|
limit?: number;
|
|
@@ -92,43 +133,87 @@ interface CustomAcademicSearchAdapter {
|
|
|
92
133
|
yearRange?: string;
|
|
93
134
|
}): Promise<AcademicPaper[]>;
|
|
94
135
|
}
|
|
136
|
+
interface ExtractedConceptNode {
|
|
137
|
+
id: string;
|
|
138
|
+
term: string;
|
|
139
|
+
termVi?: string;
|
|
140
|
+
termEn?: string;
|
|
141
|
+
category: 'core_concept' | 'api_syntax' | 'hardware_component' | 'pedagogical_pattern';
|
|
142
|
+
marrLayer: 'ULO' | 'CIO' | 'SIO';
|
|
143
|
+
bloomLevel: 'remember' | 'understand' | 'apply' | 'analyze' | 'evaluate' | 'create';
|
|
144
|
+
salienceScore: number;
|
|
145
|
+
definition: string;
|
|
146
|
+
prerequisites: string[];
|
|
147
|
+
sourceIds: string[];
|
|
148
|
+
}
|
|
149
|
+
interface SynthesizedResearchInsights {
|
|
150
|
+
executiveSummary: string;
|
|
151
|
+
keyTakeaways: string[];
|
|
152
|
+
commonMisconceptionsAndPitfalls: string[];
|
|
153
|
+
recommendedExemplars: string[];
|
|
154
|
+
extractedConcepts?: ExtractedConceptNode[];
|
|
155
|
+
}
|
|
156
|
+
interface CustomSynthesizerAdapter {
|
|
157
|
+
synthesize(input: {
|
|
158
|
+
topic: string;
|
|
159
|
+
domain: string;
|
|
160
|
+
context?: CourseResearchContext;
|
|
161
|
+
excerpts: Array<{
|
|
162
|
+
resourceId: string;
|
|
163
|
+
title: string;
|
|
164
|
+
url: string;
|
|
165
|
+
excerpt: string;
|
|
166
|
+
codeSnippets: string[];
|
|
167
|
+
}>;
|
|
168
|
+
}): Promise<SynthesizedResearchInsights>;
|
|
169
|
+
}
|
|
95
170
|
declare const ResearchConfigSchema: z.ZodObject<{
|
|
96
171
|
search: z.ZodDefault<z.ZodObject<{
|
|
97
|
-
preferredProvider: z.ZodDefault<z.ZodEnum<["tavily", "exa", "searxng", "duckduckgo", "semantic_scholar", "openalex", "arxiv", "custom"]>>;
|
|
172
|
+
preferredProvider: z.ZodDefault<z.ZodEnum<["tavily", "exa", "serper", "searxng", "duckduckgo", "semantic_scholar", "openalex", "arxiv", "custom"]>>;
|
|
98
173
|
fallbackChain: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
99
174
|
apiKeys: z.ZodDefault<z.ZodObject<{
|
|
100
175
|
tavily: z.ZodOptional<z.ZodString>;
|
|
101
176
|
exa: z.ZodOptional<z.ZodString>;
|
|
177
|
+
jina: z.ZodOptional<z.ZodString>;
|
|
178
|
+
serper: z.ZodOptional<z.ZodString>;
|
|
102
179
|
semanticScholar: z.ZodOptional<z.ZodString>;
|
|
103
180
|
}, "strip", z.ZodTypeAny, {
|
|
104
181
|
tavily?: string | undefined;
|
|
105
182
|
exa?: string | undefined;
|
|
183
|
+
serper?: string | undefined;
|
|
184
|
+
jina?: string | undefined;
|
|
106
185
|
semanticScholar?: string | undefined;
|
|
107
186
|
}, {
|
|
108
187
|
tavily?: string | undefined;
|
|
109
188
|
exa?: string | undefined;
|
|
189
|
+
serper?: string | undefined;
|
|
190
|
+
jina?: string | undefined;
|
|
110
191
|
semanticScholar?: string | undefined;
|
|
111
192
|
}>>;
|
|
112
193
|
searxngHost: z.ZodOptional<z.ZodString>;
|
|
113
194
|
timeoutMs: z.ZodDefault<z.ZodNumber>;
|
|
114
195
|
maxResultsPerQuery: z.ZodDefault<z.ZodNumber>;
|
|
115
196
|
}, "strip", z.ZodTypeAny, {
|
|
116
|
-
preferredProvider: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
197
|
+
preferredProvider: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
117
198
|
fallbackChain: string[];
|
|
118
199
|
apiKeys: {
|
|
119
200
|
tavily?: string | undefined;
|
|
120
201
|
exa?: string | undefined;
|
|
202
|
+
serper?: string | undefined;
|
|
203
|
+
jina?: string | undefined;
|
|
121
204
|
semanticScholar?: string | undefined;
|
|
122
205
|
};
|
|
123
206
|
timeoutMs: number;
|
|
124
207
|
maxResultsPerQuery: number;
|
|
125
208
|
searxngHost?: string | undefined;
|
|
126
209
|
}, {
|
|
127
|
-
preferredProvider?: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
210
|
+
preferredProvider?: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
128
211
|
fallbackChain?: string[] | undefined;
|
|
129
212
|
apiKeys?: {
|
|
130
213
|
tavily?: string | undefined;
|
|
131
214
|
exa?: string | undefined;
|
|
215
|
+
serper?: string | undefined;
|
|
216
|
+
jina?: string | undefined;
|
|
132
217
|
semanticScholar?: string | undefined;
|
|
133
218
|
} | undefined;
|
|
134
219
|
searxngHost?: string | undefined;
|
|
@@ -136,19 +221,19 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
136
221
|
maxResultsPerQuery?: number | undefined;
|
|
137
222
|
}>>;
|
|
138
223
|
crawler: z.ZodDefault<z.ZodObject<{
|
|
139
|
-
preferredProvider: z.ZodDefault<z.ZodEnum<["jina", "crawl4ai", "defuddle", "direct", "custom"]>>;
|
|
224
|
+
preferredProvider: z.ZodDefault<z.ZodEnum<["jina", "crawl4ai", "youtube", "defuddle", "direct", "custom"]>>;
|
|
140
225
|
fallbackChain: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
141
226
|
crawl4aiHost: z.ZodDefault<z.ZodString>;
|
|
142
227
|
timeoutMs: z.ZodDefault<z.ZodNumber>;
|
|
143
228
|
maxContentLength: z.ZodDefault<z.ZodNumber>;
|
|
144
229
|
}, "strip", z.ZodTypeAny, {
|
|
145
|
-
preferredProvider: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct";
|
|
230
|
+
preferredProvider: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct";
|
|
146
231
|
fallbackChain: string[];
|
|
147
232
|
timeoutMs: number;
|
|
148
233
|
crawl4aiHost: string;
|
|
149
234
|
maxContentLength: number;
|
|
150
235
|
}, {
|
|
151
|
-
preferredProvider?: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct" | undefined;
|
|
236
|
+
preferredProvider?: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct" | undefined;
|
|
152
237
|
fallbackChain?: string[] | undefined;
|
|
153
238
|
timeoutMs?: number | undefined;
|
|
154
239
|
crawl4aiHost?: string | undefined;
|
|
@@ -169,11 +254,13 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
169
254
|
}>>;
|
|
170
255
|
}, "strip", z.ZodTypeAny, {
|
|
171
256
|
search: {
|
|
172
|
-
preferredProvider: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
257
|
+
preferredProvider: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom";
|
|
173
258
|
fallbackChain: string[];
|
|
174
259
|
apiKeys: {
|
|
175
260
|
tavily?: string | undefined;
|
|
176
261
|
exa?: string | undefined;
|
|
262
|
+
serper?: string | undefined;
|
|
263
|
+
jina?: string | undefined;
|
|
177
264
|
semanticScholar?: string | undefined;
|
|
178
265
|
};
|
|
179
266
|
timeoutMs: number;
|
|
@@ -181,7 +268,7 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
181
268
|
searxngHost?: string | undefined;
|
|
182
269
|
};
|
|
183
270
|
crawler: {
|
|
184
|
-
preferredProvider: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct";
|
|
271
|
+
preferredProvider: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct";
|
|
185
272
|
fallbackChain: string[];
|
|
186
273
|
timeoutMs: number;
|
|
187
274
|
crawl4aiHost: string;
|
|
@@ -194,11 +281,13 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
194
281
|
};
|
|
195
282
|
}, {
|
|
196
283
|
search?: {
|
|
197
|
-
preferredProvider?: "tavily" | "exa" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
284
|
+
preferredProvider?: "tavily" | "exa" | "serper" | "searxng" | "duckduckgo" | "semantic_scholar" | "openalex" | "arxiv" | "custom" | undefined;
|
|
198
285
|
fallbackChain?: string[] | undefined;
|
|
199
286
|
apiKeys?: {
|
|
200
287
|
tavily?: string | undefined;
|
|
201
288
|
exa?: string | undefined;
|
|
289
|
+
serper?: string | undefined;
|
|
290
|
+
jina?: string | undefined;
|
|
202
291
|
semanticScholar?: string | undefined;
|
|
203
292
|
} | undefined;
|
|
204
293
|
searxngHost?: string | undefined;
|
|
@@ -206,7 +295,7 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
206
295
|
maxResultsPerQuery?: number | undefined;
|
|
207
296
|
} | undefined;
|
|
208
297
|
crawler?: {
|
|
209
|
-
preferredProvider?: "custom" | "jina" | "crawl4ai" | "defuddle" | "direct" | undefined;
|
|
298
|
+
preferredProvider?: "custom" | "jina" | "crawl4ai" | "youtube" | "defuddle" | "direct" | undefined;
|
|
210
299
|
fallbackChain?: string[] | undefined;
|
|
211
300
|
timeoutMs?: number | undefined;
|
|
212
301
|
crawl4aiHost?: string | undefined;
|
|
@@ -221,4 +310,4 @@ declare const ResearchConfigSchema: z.ZodObject<{
|
|
|
221
310
|
type ResearchConfig = z.infer<typeof ResearchConfigSchema>;
|
|
222
311
|
declare const DEFAULT_RESEARCH_CONFIG: ResearchConfig;
|
|
223
312
|
|
|
224
|
-
export {
|
|
313
|
+
export { type AcademicPaper as A, type CourseResearchContext as C, DEFAULT_RESEARCH_CONFIG as D, type ExtractedConceptNode as E, type LlmTextFn as L, type ResearchApiKeys as R, type SearchProviderType as S, type CustomSearchAdapter as a, type CustomCrawlerAdapter as b, type CustomAcademicSearchAdapter as c, type CustomSynthesizerAdapter as d, type CrawlerProviderType as e, type SynthesizedResearchInsights as f, ResearchConfigSchema as g, type ResearchConfig as h, AcademicPaperSchema as i, type AcademicSearchOptions as j, AcademicSearchEngine as k, reconstructOpenAlexAbstract as r };
|