ユーザーガイド

このガイドでは、Schiftを最もよく使う方法を説明します。ダッシュボード、REST API、PythonおよびTypeScript SDK、CLI、Model Context Protocol（MCP）サーバーをカバーします。

始める前に

SchiftアカウントとAPIキーが必要です。まだキーをお持ちでない場合は、{appUrl}のダッシュボードから作成してください。

以下の例の多くは環境変数を使用します：

export SCHIFT_API_KEY=sch_your_key_here
export SCHIFT_API_URL=<your-api-url>

この環境では SCHIFT_API_URL を {apiUrl} に設定してください。APIキーは秘密にし、定期的にローテーションし、環境ごとに別々のキーを使用してください。

適切なインターフェースを選択する

インターフェース	最適な用途	エントリーポイント
Dashboard	キー管理、請求、バケット状態の確認	{appUrl}
REST API	直接のバックエンド統合	{apiUrl}
Python SDK	スクリプト、取り込み、検索、移行	pip install schift
TypeScript SDK	TypeScriptまたはNode.jsアプリケーション	npm install @schift-io/sdk
CLI	反復可能なターミナル操作	pip install schift-cli
MCP	Claude DesktopまたはClaude Code接続	npx schift-mcp

クイックインストールチェックリスト

# Python SDK
pip install schift

# TypeScript SDK
npm install @schift-io/sdk

# CLI
pip install schift-cli
schift --help

# MCP server
npx schift-mcp

一般的なワークフロー

1. ダッシュボードまたはPOST /v2/bucketsでバケットを作成します。
2. POST /v2/buckets/{bucket_id}/documentsでバケットにドキュメントをアップロードします。
3. インデックス作成が完了するのを待ち、GET /v2/buckets/{bucket_id}/search/statusで準備状況を確認します。
4. POST /v2/buckets/{bucket_id}/searchでバケットを検索し、引用付きのコンテキストを取得します。
5. POST /v1/chatで質問し、バケットベースのRAG回答を取得します。

注： バケット検索は、アップロード優先の取り込み最適化インターフェースです。POST /v1/collections/{name}/searchは、レガシー統合でのみ使用してください。

一般的なエンドポイント

• POST /v2/buckets
• POST /v2/buckets/{bucket_id}/documents
• GET /v2/buckets/{bucket_id}/search/status
• POST /v2/buckets/{bucket_id}/search
• POST /v1/chat
• POST /v1/chat/completions

認証

すべてのAPIリクエストはBearer認証を使用します：

curl -H "Authorization: Bearer $SCHIFT_API_KEY" \
  $SCHIFT_API_URL/v2/buckets

SDK、CLI、MCPでも同じSCHIFT_API_KEY値を使用してください。そうすることで、同じ環境で異なるキーが使用されるのを防ぎます。

次のステップ

• バケットでナレッジを作成・管理します。
• バケット検索でアップロード済みコンテンツを検索します。
• RAG Chatで根拠のある回答を取得します。
• Chat CompletionsでOpenAI互換リクエストをルーティングします。
• 古い統合を移行する場合は、レガシーコレクションAPIを参照してください。

関連項目

• バケット
• レガシーコレクションAPI
• RAG Chat
• Chat Completions