mcpField
U
upstash-search-js

upstash-search-js

github.com/upstash数据与数据库341.3k 次安装1 天前更新
代码仓库

关于 upstash-search-js

upstash-search-js 为使用 Upstash Search TypeScript SDK 的开发者提供文档指导，涵盖索引、文档更新、搜索和过滤，并提供 SDK 命令及端到端设置流程参考。

主要功能

  1. 01TypeScript SDK 设置指引
  2. 02文档写入与删除
  3. 03搜索和范围查询
  4. 04元数据与内容处理
  5. 05类 SQL 和结构化过滤器

适用场景

  1. 01建立文档搜索索引
  2. 02搜索文档并选择性重排结果
  3. 03按元数据过滤结果

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/upstash/skills --skill upstash-search-js

安装后在 Claude Code 中输入/upstash-search-js确认已加载。

附带文件quick-start.mdsdk-overview.md

详细介绍

Upstash Search 文档

内置文档和源代码

在编写或调试 SDK 代码之前，请检查 node_modules/@upstash/search/docs/ 中的内置文档，以及 node_modules/@upstash/search/src/ 中易于阅读的 TypeScript 源代码。如果相关文件存在，请阅读并搜索这些文件；否则，请使用本技能中的参考资料。

快速入门

安装 TS SDK：

npm install @upstash/search

创建客户端并执行简单的 upsert + search：

import { Search } from "@upstash/search";

const client = new Search({ url: process.env.UPSTASH_SEARCH_REST_URL, token: process.env.UPSTASH_SEARCH_REST_TOKEN });
const index = client.index("my-index");

await index.upsert({ id: "1", content: { text: "hello world" } });
const results = await index.search({ query: "hello" });

基本步骤：

  • 创建索引
  • 插入或更新文档
  • 执行搜索或筛选查询

其他技能文件

sdk-overview

提供所有 TypeScript SDK 命令的详细文档。包括：

  • delete：删除文档
  • fetch：获取文档
  • info：索引信息
  • range：范围查询
  • reset：清空索引
  • search：搜索查询
  • upsert：添加或更新文档
  • getting-started：SDK 设置步骤
quick-start

提供端到端快速工作流，用于创建 Search 数据库、添加文档并查询。涵盖以下基本概念：

  • 创建数据库并保存凭据
  • 添加包含内容和元数据的文档
  • 了解内容与元数据（可搜索性和可筛选性）
  • 执行搜索，并可选择重新排序
  • 使用类似 SQL 或结构化筛选器的筛选语法
  • 常见陷阱和最佳实践

评论

支持 Markdown