@tengence/search-sdk

Tengence Search SDK: lazy auto-registration, dataset/search-app initialization, data push and full-text search (thin HTTP client, no local business database). 通智搜索 SDK：自动注册 + 初始化 + 推送 + 搜索（薄 HTTP 客户端）

latest

Source

npm

Version: 0.1.1

Version published: 2 weeks ago

Maintainers: 1

Created: 2 weeks ago

Source

@tengence/search-sdk

Tengence Search（通智搜索）SDK：懒加载自动注册 → 初始化「数据集 + 搜索应用」→ 推送数据 → 全文搜索。纯 HTTP 薄客户端，无本地业务数据库；凭据与身份保存在 ~/.tengence/search-mcp/state.json（0600）。

使用

const sdk = require("@tengence/search-sdk");

// 初始化（幂等）：自动注册客户端身份 → 服务端创建数据集+搜索应用并绑定（免费套餐）
// 首次注册返回：激活链接 / 登录地址 / 账号 / 初始密码（仅此一次明文）
await sdk.init.init({ timeoutMs: 15000 });

// 推送（单条或批量；每条必须含唯一 id；仅含 id = 删除；首次推送后自动启动搜索应用）
await sdk.push.push([{ id: "1", title: "Hello Tengence" }], { chunkSize: 100 });

// 搜索
const res = await sdk.search.search({ query: "Hello", page: 1, size: 10 });
// { items, total, took, aggs }

API

模块	方法	说明
`sdk.init`	`init({timeoutMs})`	幂等初始化；首次注册明文返回控制台登录信息
`sdk.push`	`push(records, {chunkSize, timeoutMs})`	推送/更新/删除（按 id upsert）
`sdk.search`	`search(params, {timeoutMs})`	搜索（分页/排序/过滤/高亮/聚合）
`sdk.util`	`ping({probe})`	状态与下游探测
`sdk.config`	`readConfig()` / `maskKey()`	配置读取（密钥掩码）
`sdk.identity`	`loadState` / `isRegistered` / `isInitialized` / `claimLink()`	本地身份

环境变量

变量	默认
`TENGENCE_SOLUTION_BASE_URL`	`https://console.tengence.com`
`TENGENCE_SEARCH_API_KEY` / `TENGENCE_DATASET_API_KEY`	双 API Key（不配也行，初始化自动落盘）
`TENGENCE_SITE_URL`	注册幂等键，默认 `https://tengence-mcp.local/<deviceId>`
`TENGENCE_SEARCH_HOME`	状态目录，默认 `~/.tengence/search-mcp`