@ dbx- 工具/ 共享搜索
验证 Databricks AI 搜索请求、结果、索引目录和文档 在浏览器和服务器代码中写入。 它定义了浏览器安全扩展 共有合同 @ dbx 工具/ 搜索,马斯特拉工具,和 @dbx-tools/ui/ search (英语)。 。 。 .
快开始
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限制的模型/工具友好计划 有些终点有问题.
验证请求选项
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"] },
});
验证搜索结果
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 它来自.
读取索引目录
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 工具/ 搜索 用于运行时间搜索, 索引管理,Mastra工具,以及AppKit插件. 使用 @dbx-tools/ui/ search (英语) 用于反应控制.
软件包出口
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) (中文(简体) ).