sciverse 0.3.0

package/dist/tools.d.ts

@@ -0,0 +1,357 @@
+/** Auto-generated. Do not edit. Run scripts/build.sh. */
+export declare const TOOLS_VERSION = "0.3.0";
+export declare const OPENAI_TOOLS: readonly [{
+    readonly type: "function";
+    readonly function: {
+        readonly name: "search_papers";
+        readonly description: "按结构化条件检索学术文献元数据（标题、作者、期刊、年份、摘要等）。\n适用：「查找 Hinton 在 2020-2023 年发表的论文」「找 Nature 上关于 CRISPR 的近期文献」。\n不适用：自然语言问答检索 → 用 semantic_search；查全文片段 → 用 read_content。\n返回：论文元数据列表，每条含 doc_id、title、author、abstract、publication_venue_name、publication_published_year 等。";
+        readonly parameters: {
+            readonly type: "object";
+            readonly properties: {
+                readonly query: {
+                    readonly type: "string";
+                    readonly description: "BM25 全文关键词，匹配标题/摘要/期刊名/关键词字段。留空则纯靠结构化过滤。";
+                };
+                readonly title_contains: {
+                    readonly type: "string";
+                    readonly description: "标题中必须包含的词（仅匹配 title 字段）。";
+                };
+                readonly abstract_contains: {
+                    readonly type: "string";
+                    readonly description: "摘要中必须包含的词（仅匹配 abstract 字段）。";
+                };
+                readonly authors: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "作者名（任一命中即可）。SDK 内部映射到后端 `author` 字段（FILTER_OP_IN）。";
+                };
+                readonly year_from: {
+                    readonly type: "integer";
+                    readonly description: "起始发表年（含）。";
+                };
+                readonly year_to: {
+                    readonly type: "integer";
+                    readonly description: "结束发表年（含）。";
+                };
+                readonly journals: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "期刊名（任一命中即可）。SDK 内部映射到后端 `publication_venue_name` 字段（FILTER_OP_IN）。";
+                };
+                readonly subjects: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly description: "学科分类，如 \"computer science\"、\"biology\"。";
+                };
+                readonly filters_advanced: {
+                    readonly type: "array";
+                    readonly description: "高级过滤逃生舱（仅当上述字段不够用时使用）。";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly required: readonly ["field", "value"];
+                        readonly properties: {
+                            readonly field: {
+                                readonly type: "string";
+                            };
+                            readonly operator: {
+                                readonly type: "string";
+                                readonly enum: readonly ["FILTER_OP_EQ", "FILTER_OP_NE", "FILTER_OP_GT", "FILTER_OP_GTE", "FILTER_OP_LT", "FILTER_OP_LTE", "FILTER_OP_IN", "FILTER_OP_NIN", "FILTER_OP_CONTAINS"];
+                                readonly default: "FILTER_OP_EQ";
+                            };
+                            readonly value: {};
+                        };
+                    };
+                };
+                readonly sort_by_year: {
+                    readonly type: "string";
+                    readonly enum: readonly ["desc", "asc", "none"];
+                    readonly default: "desc";
+                };
+                readonly page: {
+                    readonly type: "integer";
+                    readonly default: 1;
+                    readonly minimum: 1;
+                };
+                readonly page_size: {
+                    readonly type: "integer";
+                    readonly default: 10;
+                    readonly minimum: 1;
+                    readonly maximum: 50;
+                };
+            };
+        };
+    };
+}, {
+    readonly type: "function";
+    readonly function: {
+        readonly name: "semantic_search";
+        readonly description: "自然语言语义检索，返回相关文献片段（chunk）用于 RAG 回答。\n适用：「Transformer 注意力机制如何工作？」「最新的蛋白质折叠预测方法有哪些？」\n不适用：精确字段过滤 → search_papers；取完整原文 → read_content。\n返回：相关 chunk 列表，每条含 chunk_id/doc_id/abstract/chunk/score/title/offset。\n典型链路：semantic_search → 选取 chunk → read_content(doc_id, offset)。";
+        readonly parameters: {
+            readonly type: "object";
+            readonly required: readonly ["query"];
+            readonly properties: {
+                readonly query: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 4096;
+                    readonly description: "自然语言查询，1-200 字最佳。";
+                };
+                readonly top_k: {
+                    readonly type: "integer";
+                    readonly default: 10;
+                    readonly minimum: 1;
+                    readonly maximum: 30;
+                };
+                readonly source_types: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                        readonly enum: readonly ["web", "pdf"];
+                    };
+                };
+                readonly mode: {
+                    readonly type: "string";
+                    readonly enum: readonly ["fast", "balanced", "quality"];
+                    readonly default: "balanced";
+                    readonly description: "fast = 仅关键词召回 (~200ms)；balanced = 混合检索 (~600ms)；quality = LLM 改写 + 混合 (~2-4s)。\n";
+                };
+            };
+        };
+    };
+}, {
+    readonly type: "function";
+    readonly function: {
+        readonly name: "list_catalog";
+        readonly description: "返回 search_papers 所有可用字段的 catalog：字段名、类型、能否过滤/排序、\n是否默认返回、字段说明、FilterOperator 清单等。\n适用：「我该用哪个字段过滤 DOI?」「access_oa_status 有哪些可能值？」\n「`metadata_type` 的合法取值是？」\n不适用：实际查询文献，那是 search_papers / semantic_search 的事。\n典型用法：Agent 第一次接触 SciVerse 或碰到模糊字段需求时先调一次本接口，\n把 schema 装进 working memory，后续精确构造 search_papers 的 filters。\ninclude_sample_values=true 时返回枚举值样本（OpenSearch terms agg，缓存 24h）。";
+        readonly parameters: {
+            readonly type: "object";
+            readonly properties: {
+                readonly include_sample_values: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                    readonly description: "是否拉取 enum-like 字段的取值样本。false 仅返回静态 schema（毫秒级）；true 触发 OpenSearch terms agg（首次几百毫秒，之后 24h 走缓存）。";
+                };
+            };
+            readonly required: readonly [];
+        };
+    };
+}, {
+    readonly type: "function";
+    readonly function: {
+        readonly name: "read_content";
+        readonly description: "按字节区间读取文献原文片段。通常配合 semantic_search 返回的 doc_id/offset 使用，\n用于扩展上下文（往前/往后读更多字节）。\n返回：UTF-8 文本片段、bytes_returned、next_offset、是否还有后续。";
+        readonly parameters: {
+            readonly type: "object";
+            readonly properties: {
+                readonly doc_id: {
+                    readonly type: "string";
+                    readonly description: "文献 ID（来自 search_papers / semantic_search）。";
+                };
+                readonly offset: {
+                    readonly type: "integer";
+                    readonly format: "int64";
+                    readonly default: 0;
+                };
+                readonly limit: {
+                    readonly type: "integer";
+                    readonly format: "int64";
+                    readonly default: 4096;
+                    readonly maximum: 16384;
+                };
+            };
+            readonly required: readonly ["doc_id"];
+        };
+    };
+}, {
+    readonly type: "function";
+    readonly function: {
+        readonly name: "get_resource";
+        readonly description: "按文件名取文献中嵌入的图片字节流（PNG / JPG 等）。\n触发场景：read_content 返回的 Markdown 中含 `![alt](file_name)` 形式的图片占位，\nagent 需要把图给用户看时调本接口。\n入参 file_name 来自 markdown 内的 url 段（相对路径，禁止 `\\\\` 或 `..`）。\n返回：HTTP 二进制流 + image/* Content-Type。\nSDK / MCP server 包装层会做 base64 + mime 转换以便 agent 多模态使用。";
+        readonly parameters: {
+            readonly type: "object";
+            readonly properties: {
+                readonly file_name: {
+                    readonly type: "string";
+                    readonly description: "图片相对路径，来自 read_content Markdown 中的 `![alt](file_name)` 占位。禁止 `\\\\` 与 `..`，不能以 `/` 开头。";
+                };
+            };
+            readonly required: readonly ["file_name"];
+        };
+    };
+}];
+export declare const ANTHROPIC_TOOLS: readonly [{
+    readonly name: "search_papers";
+    readonly description: "按结构化条件检索学术文献元数据（标题、作者、期刊、年份、摘要等）。\n适用：「查找 Hinton 在 2020-2023 年发表的论文」「找 Nature 上关于 CRISPR 的近期文献」。\n不适用：自然语言问答检索 → 用 semantic_search；查全文片段 → 用 read_content。\n返回：论文元数据列表，每条含 doc_id、title、author、abstract、publication_venue_name、publication_published_year 等。";
+    readonly input_schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly query: {
+                readonly type: "string";
+                readonly description: "BM25 全文关键词，匹配标题/摘要/期刊名/关键词字段。留空则纯靠结构化过滤。";
+            };
+            readonly title_contains: {
+                readonly type: "string";
+                readonly description: "标题中必须包含的词（仅匹配 title 字段）。";
+            };
+            readonly abstract_contains: {
+                readonly type: "string";
+                readonly description: "摘要中必须包含的词（仅匹配 abstract 字段）。";
+            };
+            readonly authors: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "作者名（任一命中即可）。SDK 内部映射到后端 `author` 字段（FILTER_OP_IN）。";
+            };
+            readonly year_from: {
+                readonly type: "integer";
+                readonly description: "起始发表年（含）。";
+            };
+            readonly year_to: {
+                readonly type: "integer";
+                readonly description: "结束发表年（含）。";
+            };
+            readonly journals: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "期刊名（任一命中即可）。SDK 内部映射到后端 `publication_venue_name` 字段（FILTER_OP_IN）。";
+            };
+            readonly subjects: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly description: "学科分类，如 \"computer science\"、\"biology\"。";
+            };
+            readonly filters_advanced: {
+                readonly type: "array";
+                readonly description: "高级过滤逃生舱（仅当上述字段不够用时使用）。";
+                readonly items: {
+                    readonly type: "object";
+                    readonly required: readonly ["field", "value"];
+                    readonly properties: {
+                        readonly field: {
+                            readonly type: "string";
+                        };
+                        readonly operator: {
+                            readonly type: "string";
+                            readonly enum: readonly ["FILTER_OP_EQ", "FILTER_OP_NE", "FILTER_OP_GT", "FILTER_OP_GTE", "FILTER_OP_LT", "FILTER_OP_LTE", "FILTER_OP_IN", "FILTER_OP_NIN", "FILTER_OP_CONTAINS"];
+                            readonly default: "FILTER_OP_EQ";
+                        };
+                        readonly value: {};
+                    };
+                };
+            };
+            readonly sort_by_year: {
+                readonly type: "string";
+                readonly enum: readonly ["desc", "asc", "none"];
+                readonly default: "desc";
+            };
+            readonly page: {
+                readonly type: "integer";
+                readonly default: 1;
+                readonly minimum: 1;
+            };
+            readonly page_size: {
+                readonly type: "integer";
+                readonly default: 10;
+                readonly minimum: 1;
+                readonly maximum: 50;
+            };
+        };
+    };
+}, {
+    readonly name: "semantic_search";
+    readonly description: "自然语言语义检索，返回相关文献片段（chunk）用于 RAG 回答。\n适用：「Transformer 注意力机制如何工作？」「最新的蛋白质折叠预测方法有哪些？」\n不适用：精确字段过滤 → search_papers；取完整原文 → read_content。\n返回：相关 chunk 列表，每条含 chunk_id/doc_id/abstract/chunk/score/title/offset。\n典型链路：semantic_search → 选取 chunk → read_content(doc_id, offset)。";
+    readonly input_schema: {
+        readonly type: "object";
+        readonly required: readonly ["query"];
+        readonly properties: {
+            readonly query: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 4096;
+                readonly description: "自然语言查询，1-200 字最佳。";
+            };
+            readonly top_k: {
+                readonly type: "integer";
+                readonly default: 10;
+                readonly minimum: 1;
+                readonly maximum: 30;
+            };
+            readonly source_types: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                    readonly enum: readonly ["web", "pdf"];
+                };
+            };
+            readonly mode: {
+                readonly type: "string";
+                readonly enum: readonly ["fast", "balanced", "quality"];
+                readonly default: "balanced";
+                readonly description: "fast = 仅关键词召回 (~200ms)；balanced = 混合检索 (~600ms)；quality = LLM 改写 + 混合 (~2-4s)。\n";
+            };
+        };
+    };
+}, {
+    readonly name: "list_catalog";
+    readonly description: "返回 search_papers 所有可用字段的 catalog：字段名、类型、能否过滤/排序、\n是否默认返回、字段说明、FilterOperator 清单等。\n适用：「我该用哪个字段过滤 DOI?」「access_oa_status 有哪些可能值？」\n「`metadata_type` 的合法取值是？」\n不适用：实际查询文献，那是 search_papers / semantic_search 的事。\n典型用法：Agent 第一次接触 SciVerse 或碰到模糊字段需求时先调一次本接口，\n把 schema 装进 working memory，后续精确构造 search_papers 的 filters。\ninclude_sample_values=true 时返回枚举值样本（OpenSearch terms agg，缓存 24h）。";
+    readonly input_schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly include_sample_values: {
+                readonly type: "boolean";
+                readonly default: false;
+                readonly description: "是否拉取 enum-like 字段的取值样本。false 仅返回静态 schema（毫秒级）；true 触发 OpenSearch terms agg（首次几百毫秒，之后 24h 走缓存）。";
+            };
+        };
+        readonly required: readonly [];
+    };
+}, {
+    readonly name: "read_content";
+    readonly description: "按字节区间读取文献原文片段。通常配合 semantic_search 返回的 doc_id/offset 使用，\n用于扩展上下文（往前/往后读更多字节）。\n返回：UTF-8 文本片段、bytes_returned、next_offset、是否还有后续。";
+    readonly input_schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly doc_id: {
+                readonly type: "string";
+                readonly description: "文献 ID（来自 search_papers / semantic_search）。";
+            };
+            readonly offset: {
+                readonly type: "integer";
+                readonly format: "int64";
+                readonly default: 0;
+            };
+            readonly limit: {
+                readonly type: "integer";
+                readonly format: "int64";
+                readonly default: 4096;
+                readonly maximum: 16384;
+            };
+        };
+        readonly required: readonly ["doc_id"];
+    };
+}, {
+    readonly name: "get_resource";
+    readonly description: "按文件名取文献中嵌入的图片字节流（PNG / JPG 等）。\n触发场景：read_content 返回的 Markdown 中含 `![alt](file_name)` 形式的图片占位，\nagent 需要把图给用户看时调本接口。\n入参 file_name 来自 markdown 内的 url 段（相对路径，禁止 `\\\\` 或 `..`）。\n返回：HTTP 二进制流 + image/* Content-Type。\nSDK / MCP server 包装层会做 base64 + mime 转换以便 agent 多模态使用。";
+    readonly input_schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly file_name: {
+                readonly type: "string";
+                readonly description: "图片相对路径，来自 read_content Markdown 中的 `![alt](file_name)` 占位。禁止 `\\\\` 与 `..`，不能以 `/` 开头。";
+            };
+        };
+        readonly required: readonly ["file_name"];
+    };
+}];