레퍼런스 매뉴얼

01 설치와 extras

코어는 의존성 7개(pydantic·httpx·pyyaml·openai·pdfplumber·python-dotenv·json5)만 설치합니다. 나머지는 전부 선택 extra:

02 핵심 API

sv.verify() (일회성 사실 검증)

sv.verify(text, *, provider=None, api_key=None, model=None, **kwargs) → Report

**kwargs는 build_config 인자(tolerance, data, embedding_provider 등)를 그대로 받습니다.

Verifier (재사용 검증 엔진)

sv.Verifier(*, provider=None, api_key=None, model=None,
            embedding_provider=None, embedding_api_key=None,
            tolerance=None, data=None, config=None)

메서드: .verify(text) (= .check) · .verify_file(path), PDF/DOCX/txt · async는 .averify / .averify_file. 반환은 모두 Report.

Ruleset (규정 준수 검사)

sv.Ruleset.from_file(path, *, provider=None, api_key=None,
    embedding_provider=None, embedding_api_key=None, tolerance=None,
    chunk_size=120, name=None, agent=False) → Ruleset
sv.Ruleset.from_text(text, **kwargs) → Ruleset

메서드 (async는 a 접두):

DataSource (정답 데이터 연결)

03 결과 객체

Report (문서 단위 · iterable)

Result (주장 하나)

Verdict (규정 준수 판정)

04 설정 · 로깅 · 진행상황

sv.build_config(*, provider=None, api_key=None, model=None,
    embedding_provider=None, embedding_api_key=None,
    tolerance=None, data=None, extra=None) → dict

config/default.yaml을 깔고 인자를 덮어쓴 전체 엔진 config dict를 반환. extra는 임의 키의 deep-merge 오버라이드. 반환 dict는 직접 수정 후 Verifier(config=cfg)로 사용 가능.

sv.configure_logging(file=None, *, level="INFO", verbose=False)

with sv.progress_dashboard(*, port=8765, open_browser=True,
                            terminal=True, hold=True, web=True): ...

환경변수 SV_PROGRESS=off|terminal|web이 인자를 덮어씀. 색 끄기 NO_COLOR=1.

05 학습 API (structverify.training)

LearningLoop

LearningLoop(engine=None, base_model="unsloth/Qwen2.5-7B-Instruct")

감독 에이전트 단독 사용

데이터 유틸

LossMonitor (실시간 감독 코어)

06 CLI 명령어

python -m structverify.training.recipe.train_qlora (NVIDIA QLoRA)

python -m structverify.training.recipe.train_mlx (Apple Silicon LoRA)

python -m structverify.training.recipe.sample (어댑터 스모크 테스트)

07 config 설정값 (config/default.yaml)

build_config()가 이 파일을 기본으로 깔고 인자를 덮어씁니다. 임의 키는 build_config(extra={...})(deep-merge) 또는 반환 dict 직접 수정으로 오버라이드.

llm (판정용 LLM)

embedding · verification

agent (ReAct 루프)

data_sources (검증 기준 데이터)

catalog_search · candidate_detection

domain · 기타 인프라

08 환경변수

09 학습 모델 주입

학습된 어댑터를 OpenAI 호환 엔드포인트로 서빙(Ollama ADAPTER / vLLM --enable-lora)한 뒤, config 두 줄로 파이프라인에 꽂습니다. 티어 단위 부분 주입이 가능해서 학습된 자리만 점진 전환:

cfg = sv.build_config(provider="upstage", api_key="none", data=data)
cfg["llm"]["base_url"] = "http://GPU서버:11434/v1"     # 자체 서빙 주소
cfg["llm"]["models"]   = {"structured": "sv-tuned"} # 스키마·판정 자리만 교체
tuned = sv.Verifier(config=cfg)
gate = loop.evaluate(eval_set, tuned_engine=tuned)      # 개선 확인 후 채택

StructVerify v0.3.4 · MIT License. 개념·시작 안내는 사용법, 학습 배경·데이터 전략은 학습 가이드, 실행 화면은 3분 데모 영상 참조.