mcpField
U
upstash-search-js

upstash-search-js

github.com/upstashデータ・データベース341.3k 回インストール2 日前に更新
リポジトリ

upstash-search-js について

upstash-search-js は、Upstash Search TypeScript SDK を使う開発者向けのドキュメントスキルです。インデックス作成、文書更新、検索、フィルタリングを扱い、SDK コマンドと一連のセットアップ手順を参照できます。

主な機能

  1. 01TypeScript SDK のセットアップ案内
  2. 02文書の登録と削除
  3. 03検索と範囲クエリ
  4. 04メタデータとコンテンツの扱い
  5. 05SQL風・構造化フィルター

活用シーン

  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/ で、読みやすい TypeScript のソースコードを node_modules/@upstash/search/src/ で確認してください。該当するファイルがある場合は読み込んで検索し、ない場合はこのスキル内のリファレンスを使用してください。

クイックスタート

TS SDK をインストールします。

npm install @upstash/search

クライアントを作成し、簡単な upsert と検索を実行します。

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 対応