# @dbx-tools/shared-search 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/shared-search/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:09.202Z
中文译文更新时间：2026-11-11T17:30:18.021Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dbx-tools/shared-search
原文对照：https://npmcn.com/package/%40dbx-tools/shared-search/?lang=original
项目主页：https://github.com/reggie-db/dbx-tools#readme
源码仓库：https://github.com/reggie-db/dbx-tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：78.3 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-07-31T02:08:34.569Z
- 最新版本发布：2026-11-10T19:18:08.581Z
- 近 30 天下载量：9770（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：287（近 12 个月 287 个）

## 中文简介

AppKit 兼容的 AI 搜索提供者的浏览器安全计划和扩展类型

## 安装

```sh
npm install @dbx-tools/shared-search
```

也可以使用：`pnpm add @dbx-tools/shared-search`、`yarn add @dbx-tools/shared-search`、`bun add @dbx-tools/shared-search`

## README

# @ dbx- 工具/ 共享搜索

验证 Databricks AI 搜索请求、结果、索引目录和文档 在浏览器和服务器代码中写入。 它定义了浏览器安全扩展 共有合同 [@ dbx 工具/ 搜索](https://npmcn.com/package/node/search),马斯特拉工具,和 [@dbx-tools/ui/ search (英语)](https://npmcn.com/package/ui/appkit)。 。 。 .

## 快开始

```ts
import { searchSchemas } from "@dbx-tools/shared-search";

const request = searchSchemas.searchRequestSchema.parse({
  query: "reset my password",
  index: "main.support.docs",
  limit: 5,
});
```

计划包括:

-   共享 `SearchRequest` 编号 : `SearchResult` 与合同 `{ id, score, fields }` 点击,所以一个自动完成框,一个文件查询,和一个Mastra工具说出一个形状.
-   `SearchMode` (单位:千美元)`hybrid` 编号 : `vector` 编号 : `keyword`+) 加上 (中文(简体) ) `toAiSearchQueryType()` 用于 AppKit 查询词汇.
-   `UniversalSearchRequest` 用于同时进行多个索引的联邦搜索.
-   `SearchDocument` 编号 : `UpsertResult` 用于添加和更新直接存取索引 目录.
-   `SearchIndexInfo` 编号 : `SearchClientConfig` 启动时索引目录 a 搜索框读取时没有服务器回路.
-   避免JSON Schema限制的模型/工具友好计划 有些终点有问题.

## 验证请求选项

```ts
import { searchSchemas, type SearchRequest } from "@dbx-tools/shared-search";

const request: SearchRequest = searchSchemas.searchRequestSchema.parse({
  query: "reset my password",
  index: "main.support.docs",
  limit: 5,
  mode: "hybrid",
  filter: { locale: "en", category: ["billing", "support"] },
});
```

## 验证搜索结果

```ts
import { searchSchemas } from "@dbx-tools/shared-search";

export function resultTitles(payload: unknown): unknown[] {
  const result = searchSchemas.searchResultSchema.parse(payload);
  return result.hits.map((hit) => hit.fields.title);
}
```

`searchHitSchema` 返回请求的列 `fields`按列键 名称,加上主键 `id` 关联性 `score`联合打击 携带 `index` 它来自.

## 读取索引目录

```ts
import { getPluginClientConfig } from "@databricks/appkit-ui";
import { SEARCH_PLUGIN_NAME, searchSchemas } from "@dbx-tools/shared-search";

const config = searchSchemas.searchClientConfigSchema.parse(
  getPluginClientConfig(SEARCH_PLUGIN_NAME),
);
```

`searchClientConfigSchema` 校验用于通用的扩展目录 搜索。 搜索。 单索引用户界面查询已读取 AppKit 已发布 `aiSearch` 客户端 换成配置.

## 运行时边界

此软件包不查询索引,不读取 Databricks 证书,也不选择 搜索后端。 使用 [@ dbx 工具/ 搜索](https://npmcn.com/package/node/search) 用于运行时间搜索, 索引管理,Mastra工具,以及AppKit插件. 使用 [@dbx-tools/ui/ search (英语)](https://npmcn.com/package/ui/appkit) 用于反应控制.

## 软件包出口

-   `SEARCH_PLUGIN_NAME`, (中文(简体) ), `SEARCH_DEFAULT_BASE_PATH`,以及 `SEARCH_ROUTES` 拥有 扩展插件的浏览器安全路由合同; `searchSchemas.searchRoute` 与这些路由段一起加入已公布的基础路径.
-   `searchSchemas`数字 : `searchModeSchema`, (中文(简体) ), `searchRequestSchema`, (中文(简体) ), `searchHitSchema`, (中文(简体) ), `searchResultSchema`, (中文(简体) ), `universalSearchRequestSchema`, (中文(简体) ), `searchDocumentSchema`, (中文(简体) ), `upsertResultSchema`, (中文(简体) ), `searchIndexInfoSchema`, (中文(简体) ), `searchClientConfigSchema`,以及 `toAiSearchQueryType`,以及 假设的平地类型(`SearchMode`, (中文(简体) ), `SearchRequest`, (中文(简体) ), `SearchHit`, (中文(简体) ), `SearchResult`, (中文(简体) ), `UniversalSearchRequest`, (中文(简体) ), `SearchDocument`, (中文(简体) ), `UpsertResult`, (中文(简体) ), `SearchIndexInfo`, (中文(简体) ), `SearchClientConfig`) (中文(简体) ).

## 常见问题

### @dbx-tools/shared-search 是什么？

AppKit 兼容的 AI 搜索提供者的浏览器安全计划和扩展类型

### 如何安装 @dbx-tools/shared-search？

在项目目录运行 npm install @dbx-tools/shared-search，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/shared-search 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dbx-tools/shared-search 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dbx-tools/shared-search 可以商用吗？

@dbx-tools/shared-search 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/shared-search 的下载量有多少？

根据 npm 官方下载统计，@dbx-tools/shared-search 在 2026/10/12 – 2026/11/10 这 30 天内被下载 9,770 次，日均约 326 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dbx-tools/shared-search 还在维护吗？

最新版本 0\.9\.206 发布于 2026/11/11（今天）；至今共发布 287 个版本，其中过去 12 个月发布了 287 个；首次发布于 2026/07/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。