paradedb-skill について
ParadeDB に関する質問への回答を支援するスキルです。ParadeDB は Postgres のテキスト・ベクトル検索、フィルター、ファセット、結合向け拡張で、付属スクリプトによるドキュメント参照と、バージョンに応じた実行可能な SQL 例を重視します。
主な機能
- 01ParadeDB の検索とインデックスの案内
- 02テキスト・ベクトル・ハイブリッド検索の説明
- 03トークナイザー、ファセット、結合の解説
- 04付属スクリプトによるドキュメント参照
- 05バージョンに応じた SQL ガイダンス
活用シーン
- 01ParadeDB のインデックスやランキングに関する回答
- 02検索述語とクエリ関数の選択
- 03デプロイや性能調整の情報確認
- 04ParadeDB 機能を使う SQL 例の作成
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ paradedb/ agent-skills --skill paradedb-skillインストール後、Claude Code で/paradedb-skillを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
.gitignoreEXAMPLES.mdLICENSEREADME.mdscripts/paradedb-docs詳細
ParadeDB スキル
ParadeDB は、pg_search 拡張機能を使って、Postgres でのテキスト検索、ベクトル検索、フィルター、ファセット、結合を高速化します。
ユーザーから次のような質問があった場合に、このスキルを使用してください。
- ParadeDB のインデックス、BM25 スコアリング、関連性ランキング
- ベクトル検索とハイブリッド検索(キーワード検索+セマンティック検索を、逆順位融合で統合)
- トークナイザー、トークンフィルター、あいまい検索、フレーズクエリ
- ファセット、集計、スニペット/ハイライト、結合、クエリのチューニング
最新の ParadeDB ドキュメントを参照するには、同梱スクリプトの
scripts/paradedb-docs を使って、ドキュメントのインデックス
(llms.txt)を必ず取得してください。
このパスは、現在の作業ディレクトリやリポジトリのルートではなく、
この SKILL.md が含まれるディレクトリを基準に解決してください。
scripts/paradedb-docs llms.txt
インデックスを取得したら、ユーザーの質問に関連するページのみを取得してください。
インデックス内の URL から /docs/ の後に続くパスを渡してください(.md のサフィックスも含めます)。
よく使うコマンドは次のとおりです。
# Getting started and application integrations
scripts/paradedb-docs start/configure-your-environment.md
scripts/paradedb-docs reference/indexing/create-index.md
scripts/paradedb-docs reference/indexing/columnar.md
scripts/paradedb-docs reference/indexing/partition-by.md
scripts/paradedb-docs reference/indexing/faster-bm25-queries.md
scripts/paradedb-docs reference/full-text/match.md
scripts/paradedb-docs reference/full-text/top-k.md
# Filters, facets, and joins
scripts/paradedb-docs reference/filtering/overview.md
scripts/paradedb-docs reference/filtering/indexed.md
scripts/paradedb-docs reference/filtering/external-indexes.md
scripts/paradedb-docs reference/aggregates/overview.md
scripts/paradedb-docs reference/aggregates/facets.md
scripts/paradedb-docs reference/aggregates/limitations.md
scripts/paradedb-docs reference/joins/overview.md
# Vector and hybrid search
scripts/paradedb-docs reference/indexing/indexing-vectors.md
scripts/paradedb-docs reference/vector/querying.md
scripts/paradedb-docs reference/vector/tuning.md
scripts/paradedb-docs reference/hybrid/rrf.md
# Tokenizers and token filters
scripts/paradedb-docs reference/tokenizers/overview.md
scripts/paradedb-docs reference/token-filters/overview.md
scripts/paradedb-docs reference/tokenizers/available-tokenizers/jieba.md
scripts/paradedb-docs reference/tokenizers/available-tokenizers/chinese-compatible.md
# Performance, upgrades, and index maintenance
scripts/paradedb-docs operate/performance-tuning/reads.md
scripts/paradedb-docs operate/deploy/upgrading.md
scripts/paradedb-docs operate/index-maintenance/reindexing.md
# SQL APIs and runtime settings
scripts/paradedb-docs reference/operators-and-functions.md
scripts/paradedb-docs reference/sql-functions.md
scripts/paradedb-docs reference/configuration.md
検索述語を選ぶ際は演算子リファレンスを、呼び出し可能な API とインデックスの確認には SQL 関数リファレンスを、実行時設定には構成リファレンスを使用してください。デプロイ、メンテナンス、アップグレード、パフォーマンスのチューニングについては、インデックス内の該当する operate/ ページを参照してください。
取得が成功したら、その内容をセッション中にキャッシュされたコンテキストとして扱い、該当する場合は同じセッションでの後続の ParadeDB に関する質問にも再利用してください。 以前取得したドキュメントが引き続き利用可能で、質問にも関連する場合は、毎回再取得しないでください。
このツールは内部で curl を使用し、ネットワークアクセスが必要です。ネットワークアクセスを有効にして実行してください。 ツールの実行許可をユーザーに求める必要がある場合は、すべてのページを取得できるよう、すべての引数についてコマンドを実行する許可を求めてください。
ドキュメントの取得には、scripts/paradedb-docs 以外のツールを使用しないでください。
応答ガイドライン
- 説明文だけの回答より、実行可能な SQL の例を優先してください。
- 構文がバージョンによって異なる可能性がある場合は、ParadeDB/Postgres のバージョンに関する前提を明記してください。一部の機能は新しいバージョンでのみ利用できます。回答にデータベースへのアクセスが必要な場合は、まず
SELECT extversion FROM pg_extension WHERE extname = 'pg_search';で確認してください。 - 動作が不確かな場合は、推測せず、その旨を明示してください。
- ユーザーが古いバージョンとの互換性を求めていない限り、非推奨の構文よりも、現在の検索演算子や
pdb.*のクエリビルダー、スコアリング、ハイライト関数を優先してください。paradedbの出現箇所をすべて置き換えないでください。USING paradedb、paradedb.enable_custom_scanなどの実行時設定、およびparadedbスキーマにあるドキュメント記載済みの運用関数は、現在も有効です。これらの名前を変更する前に、SQL 関数リファレンスと構成リファレンスを確認してください。 - バージョン 0.25.0 では、ベクトル検索、集計、上位 K 件の取得、フィルタリングにも対応するようになったため、BM25 インデックスは ParadeDB インデックスに名称変更されました。
USING bm25ではなく、CREATE INDEX ... USING paradedbと記述し、ParadeDB インデックスと呼んでください。BM25はスコアリング関数そのものを指す場合に限って使用してください。 - バージョン 0.25.0 以降、ベクトル検索は ParadeDB インデックス内で実行されますが、ベータ機能です。
pg_searchのインストールまたはアップグレードの前に、同じデータベースにvector拡張機能をインストールしてください。ParadeDB は pgvector のvector型をインデックス化しますが、pgvector の HNSW インデックスや IVFFlat インデックスは使用しません。ParadeDB インデックス内にあるベクトル列に対して、これらを提案しないでください。 ベクトルクエリを記述する前にreference/indexing/indexing-vectors.mdとreference/vector/querying.mdを取得し、ハイブリッドクエリを記述する前にreference/hybrid/rrf.mdを取得してください。
ネットワーク障害時のルール(必須)
DNS/ネットワーク/アクセスエラーによりドキュメントを取得できない場合:
- オンラインのドキュメントにアクセスできなかったことを明確に伝え、実際のエラーも記載してください。
- 以前の取得時にキャッシュされたセッションのドキュメントがある場合は、そのキャッシュを使って続行できることを伝えてください。ユーザーが中止を希望する場合は、その意向に従ってください。
- キャッシュされたセッションのドキュメントがない場合は、ローカル/リポジトリ内の情報のみで進めるか、後で再試行するかを尋ねてください。
- ドキュメントの URL、ページパス、機能の提供状況を創作したり推測したりしないでください。
- 未確認のリンクを実在するものとして提示しないでください。
- 代替案を示す場合は、推測であることを明記し、必要最小限にとどめてください。
ネットワークアクセスに失敗した場合、推測したドキュメント構成に黙って切り替えないでください。