워크플로우

포맷 선택 가이드

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-kr"
      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": "ko"}}'

# 실행 이력 조회
curl https://api.schift.io/v1/workflows/{id}/runs \
  -H "Authorization: Bearer $SCHIFT_API_KEY"

실행 응답에는 status, outputs, 블록별 block_states(소요 시간 포함), 실패 시 error가 포함됩니다.

웹훅 트리거

외부 시스템에서 워크플로우를 트리거할 수 있습니다. /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로 요약"}'