ワークフロー

フォーマット選択ガイド

SchiftワークフローはYAMLとJSONの両方をサポートします。用途に合わせて選んでください:

YAMLスキーマリファレンス

ワークフローYAMLは4つのトップレベルキーで構成されます: version、name、blocks、edges。

yamlversion: 1                    # 必須。常に1。
name: "法律文書QA"             # 必須。表示名。
description: "リランキング付き法律文書RAGパイプライン"

blocks:
  - id: start                  # ユニークID（edgesで参照）
    type: start                # ブロックタイプ（下表参照）

  - id: retriever
    type: retriever
    title: "法律文書検索"    # オプションの表示名
    config:                     # ブロック固有のパラメータ
      collection: "legal-jp"
      top_k: 10
      rerank: true
      rerank_top_k: 3

  - id: prompt
    type: prompt_template
    config:
      template: |
        コンテキスト:
        {{results}}

        質問: {{query}}
        質問と同じ言語で回答してください。

  - id: llm
    type: llm
    config:
      model: "openai/gpt-4.1-nano"
      temperature: 0.3
      max_tokens: 1024

  - id: answer
    type: answer

  - id: end
    type: end

edges:
  - source: start
    target: retriever
  - source: retriever
    target: prompt
  - source: prompt
    target: llm
  - source: llm
    target: answer
  - source: answer
    target: end

ブロックタイプ

GET /v1/workflows/meta/block-typesで利用可能なタイプを取得できます。全リファレンス:

SDKクイックスタート

両SDKともフルライフサイクルをサポート: 作成、YAMLインポート/エクスポート、実行、管理。

pythonfrom schift import Schift

client = Schift(api_key="sch_xxx")

# 方法1: YAMLファイルから作成
wf = client.workflows.push_yaml("pipeline.yaml")

# 方法2: テンプレートから作成
wf = client.workflows.create("My RAG", template="BASIC_RAG")

# 方法3: ステップバイステップで構築
wf = client.workflows.create("カスタムパイプライン")
client.workflows.add_block(wf.id, "retriever", config={"collection": "docs", "top_k": 5})
client.workflows.add_block(wf.id, "llm", config={"model": "openai/gpt-4.1-nano"})
client.workflows.add_edge(wf.id, source="retriever", target="llm")

# 実行
result = client.workflows.run(wf.id, inputs={"query": "返品ポリシーは?"})
print(result.outputs)

# YAMLでエクスポート（バージョン管理用）
yaml_str = client.workflows.to_yaml(wf.id, path="pipeline.yaml")

typescriptimport { Schift } from "@schift-io/sdk";

const schift = new Schift({ apiKey: "sch_xxx" });

// 方法1: YAML文字列からインポート（js-yamlが必要）
const wf = await schift.workflows.importYaml(yamlString);

// 方法2: テンプレートから作成
const wf2 = await schift.workflows.create({ name: "My RAG", template: "BASIC_RAG" });

// 方法3: ステップバイステップで構築
const wf3 = await schift.workflows.create({ name: "カスタム" });
await schift.workflows.addBlock(wf3.id, { type: "retriever", config: { collection: "docs" } });
await schift.workflows.addBlock(wf3.id, { type: "llm", config: { model: "openai/gpt-4.1-nano" } });
await schift.workflows.addEdge(wf3.id, { source: "retriever", target: "llm" });

// 実行
const run = await schift.workflows.run(wf3.id, { query: "返品ポリシーは?" });

// YAMLでエクスポート
const yaml = await schift.workflows.exportYaml(wf3.id);

REST APIリファレンス

bash# YAMLファイルをRESTでインポート
curl -X POST https://api.schift.io/v1/workflows/import \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $SCHIFT_API_KEY" \
  -d '{"yaml": "version: 1\nname: My Pipeline\nblocks:\n  - id: start\n    type: start\n  - id: end\n    type: end\nedges:\n  - source: start\n    target: end"}'

# YAMLでエクスポート
curl https://api.schift.io/v1/workflows/{id}/export?format=yaml \
  -H "Authorization: Bearer $SCHIFT_API_KEY"

# JSONでエクスポート
curl https://api.schift.io/v1/workflows/{id}/export?format=json \
  -H "Authorization: Bearer $SCHIFT_API_KEY"

LLMプロバイダールーティング

llmブロックはモデルプレフィックスでプロバイダーを自動ルーティングします:

APIキーは組織設定を優先確認し、なければ環境変数（OPENAI_API_KEY、ANTHROPIC_API_KEY、GOOGLE_API_KEY）を使用します。

テンプレート

GET /v1/workflows/meta/templatesで利用可能なテンプレートを取得できます。

実行

複数の入力変数を渡せます。Startノードがすべての変数を下流ブロックに転送します。

bash# 実行前に検証
curl -X POST https://api.schift.io/v1/workflows/{id}/validate \
  -H "Authorization: Bearer $SCHIFT_API_KEY"

# 入力値で実行
curl -X POST https://api.schift.io/v1/workflows/{id}/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $SCHIFT_API_KEY" \
  -d '{"inputs": {"query": "産休制度", "language": "ja"}}'

# 実行履歴
curl https://api.schift.io/v1/workflows/{id}/runs \
  -H "Authorization: Bearer $SCHIFT_API_KEY"

実行レスポンスにはstatus、outputs、ブロックごとのblock_states（所要時間含む）、失敗時のerrorが含まれます。

Webhookトリガー

外部システムからワークフローをトリガーできます。/v1/workflows/{id}/webhook/{path}にPOSTするとペイロードがワークフロー入力（body、headers、query_params）として渡されます。

AI生成（有料）

POST /v1/workflows/generateは自然言語の説明からワークフローグラフを生成します。生成されたグラフはレビュー用に返され、自動保存されません。

bashcurl -X POST https://api.schift.io/v1/workflows/generate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $SCHIFT_API_KEY" \
  -d '{"prompt": "ドキュメントを検索してリランキングし、GPT-4oで要約"}'