クイックスタート

前提条件

Python 3.11+
ワークスペースAPIキー（ダッシュボードを開く）
ワークスペース用に設定されたAPIオリジン

CLIのインストール

python3 -m pip install schift-cli
export SCHIFT_API_KEY=sch_...
export SCHIFT_API_URL=https://api.example.com/v1

検索可能なバケットを作成する

まず1つのドキュメントから始めます。これにより、キー、APIオリジン、アップロードパス、検索パスが正しいことを確認してから、その周りにUIを構築できます。

schift db create support-docs
schift upload ./handbook.pdf --bucket support-docs
schift search "How do I reset my password?" --bucket support-docs --top-k 5

検索コマンドは、最も一致するチャンクとソースメタデータを返します。

同じバケットをエージェントに追加する

取得パスをアプリやサービスに組み込む準備ができたら、TypeScript SDKを使用します。

import { WorkspaceClient, Agent, RAG } from "@schift-io/sdk";

const client = new WorkspaceClient({ apiKey: process.env.SCHIFT_API_KEY });
const rag = new RAG({ bucket: "support-docs" }, client.transport);

const agent = new Agent({
  name: "Support Bot",
  instructions: "Answer questions using the knowledge base.",
  rag,
  model: "gpt-4o-mini",
  transport: client.transport,
});

WorkspaceClient — 設定済みのAPIオリジンに接続します
RAG — ドキュメントバケットをラップします（OCR、チャンキング、埋め込み、検索はすべて管理済み）
Agent — ReActループを実行します：質問を受信 → ドキュメントを検索 → 回答を生成

アプリスターター

新規プロジェクトは、ダッシュボードのAPM/workspace-packフロー、または上記のSDK構成から始めるべきです。create-schiftは、古い生成プロジェクト用の非推奨互換スキャフォールドとしてのみ残っています。

次のステップ

エージェントの概念 — ReActループの動作方式
ツール — エージェントにカスタム機能を追加する
RAG — ドキュメントをアップロードし、検索を設定する