ドキュメント

ユーザーガイド

ダッシュボード、API、SDK、CLI、MCP を軸に Schift を実運用するための実践ガイドです。

Schift はドキュメントのアップロード、検索、出典付き回答をまとめて提供する managed RAG インフラです。同じデータ面をダッシュボード、REST API、SDK、CLI、MCP から共通して使えます。

どのサーフェスを使うか

サーフェス	使う場面	入口
ダッシュボード	API キー、課金、バケット状態をブラウザで管理したいとき	`https://schift.io/app`
REST API	自前のバックエンドやサービスに最小構成で統合したいとき	`https://api.schift.io`
Python SDK	スクリプト、ingestion、検索、migration を素早く回したいとき	`pip install schift`
TypeScript SDK	TS または Node 環境から Schift を使うとき	`npm install @schift-io/sdk`
CLI	繰り返し可能なターミナル操作や運用フローが欲しいとき	`pip install schift-cli`
MCP	Claude Desktop や Claude Code から Schift を直接つなぎたいとき	`npx schift-mcp`

基本フロー

ダッシュボードで API キーを作成またはコピーします。
ファイルをバケットへアップロードするか、Hosted Collection にドキュメントを書き込みます。
検索だけなら bucket search や query、回答まで一発で欲しければ RAG chat を使います。
同じキーを SDK、CLI、MCP にも渡して、ローカルツールと本番環境を同じアカウントにそろえます。

統合チェックリスト

bash# REST API
export SCHIFT_API_KEY=sch_your_key_here

# Python SDK
pip install schift

# TypeScript SDK
npm install @schift-io/sdk

# CLI
pip install schift-cli

# MCP
npx schift-mcp

キーを 1 つの基準にそろえる

環境ごとに生きている API キーを 1 つ決め、可能なら SCHIFT_API_KEY 環境変数を基準にしてください。SDK、CLI、MCP の設定ずれを減らせます。

よく使う操作

目的	推奨ルート
生ファイルを上げて OCR、チャンキング、埋め込みを任せる	`POST /v1/buckets/{id}/upload` または SDK の bucket helper
アップロード済み文書全体をセマンティック検索する	`POST /v1/buckets/{id}/search` または `client.query(...)`
出典付き回答を 1 回で返す	`POST /v1/chat`
OpenAI 互換 LLM ルーターとして使う	`POST /v1/chat/completions`