✨ Promptbook란?

Promptbook은 AI 애플리케이션(챗봇, 지식베이스, 에이전트, 번역기, 자동화 등)을 사람이 읽고 쓸 수 있는 언어로 작성할 수 있게 해주는 혁신적인 생태계예요.

"이제 패러다임의 전환이 필요합니다! 소프트웨어의 미래는 영어, 프랑스어, 라틴어 같은 평범한 언어에 있습니다."

🚀 새로운 기능들

• VSCode 플러그인: .book 확장자를 지원하는 VSCode 플러그인 제공
• 도커 이미지: Docker 이미지로도 사용 가능
• OpenAI o3-mini 모델 지원: o3-mini 모델 지원
• DeepSeek 모델 지원: DeepSeek 모델 지원

⚠️ 경고: 이 라이브러리는 프리릴리즈(pre-release) 버전입니다. 아직 프로덕션 환경에서는 사용하지 않는 것이 좋아요.
자세한 내용은 최신 안정화 버전을 참고하세요.

📦 @promptbook/markitdown 패키지란?

• Promptbook은 여러 개의 패키지로 나뉘어 있고, 모두 하나의 모노레포에서 관리돼요.
• @promptbook/markitdown은 그 중 하나로, Microsoft의 Markitdown을 Promptbook에 통합한 패키지입니다.

설치 방법

# 전체 Promptbook 생태계 설치
npm i ptbk

# 이 패키지만 설치 (용량 절약)
npm install @promptbook/markitdown

🤍 The Book Abstract

"우리는 이미 여러 세대의 컴퓨터 언어를 경험했습니다. 그리고 이제, 다음 혁명의 문턱에 서 있습니다!"

• Book 언어는 사람이 이해할 수 있는 언어로 소프트웨어를 작성하고,
  AI와 사람이 모두 이해하고 실행할 수 있는 새로운 패러다임을 제시합니다.
• 마이크로프로세서의 발전과 Moore의 법칙이 언어의 진화를 이끌었듯,
  대형 언어 모델(LLM)이 앞으로의 혁신을 주도할 거예요.

"이 변화는 우리가 준비됐든 아니든 일어날 것입니다. 우리의 목표는 '그저 좋은' 것이 아니라 '탁월한' 것을 만드는 것입니다."

🚀 시작하기

• Hello World 예제와 함께 Book을 바로 체험해보세요!
  • Hello Book
  • Node.js용 Hello Book
  • Next.js용 Hello Book

💜 Promptbook 프로젝트 구성

Promptbook은 다양한 프로젝트와 도구로 이루어진 생태계입니다.

• VSCode 플러그인: .book 파일 지원
• 커뮤니티: Discord, Landing page, Github Discussions, LinkedIn, Facebook
• 서브 브랜드:
  • Promptujeme (체코 고객용)
  • Promptbook.city (이미지/그래픽 생성용)

💙 Book 언어란?

Book 언어는 AI 앱, 에이전트, 워크플로우, 자동화, 지식베이스, 번역기, 시트 처리, 이메일 자동화 등
AI 모델의 복잡한 세부사항을 몰라도 사람처럼 쉽게 작성할 수 있는 언어예요.

📄 예시

# 🌟 My first Book

- BOOK VERSION 1.0.0
- URL https://promptbook.studio/hello.book
- INPUT PARAMETER {topic}
- OUTPUT PARAMETER {article}

# Write an article

- PERSONA Jane, 마케팅 전문가 (기술 및 AI 기사 작성 경험)
- KNOWLEDGE https://wikipedia.org/
- KNOWLEDGE ./journalist-ethics.pdf
- EXPECT MIN 1 문장
- EXPECT MAX 5 페이지
  > {topic}에 대한 기사를 작성하세요
  > -> {article}

Book 언어의 3가지 핵심 원

1. What: 워크플로우, 작업, 파라미터

• 무엇을 할 것인가?
  각 Book은 워크플로우(시나리오/파이프라인)를 정의해요.
  예: 주제를 받아 기사를 생성하는 워크플로우

2. Who: 페르소나

• 누가 할 것인가?
  각 작업은 페르소나(가상 직원)가 수행합니다.

  "Jane, 창의적인 작가이자 날카로운 유머 감각을 가진 사람"
  처럼 자연어로 설명할 수 있어요.

3. How: 지식, 도구, 액션

• 어떻게 할 것인가?
  페르소나가 사용할 지식(문서, 웹사이트 등),
  도구(실시간 데이터, 계산 등),
  액션(이메일 전송, 파일 생성 등)을 지정할 수 있어요.

📌 Book 언어의 일반 원칙

• 마크다운 기반 (읽고 쓰기 쉬움)
• .book 확장자 사용, UTF-8 인코딩
• Flat(구조 없음) / Full(구조화) 두 가지 형태
• 버전 관리(git 등)와 호환
• 비전문가도 이해 가능

🔒 보안

• 보안 취약점 신고는 Security Policy 참고

📦 개발자를 위한 패키지

Promptbook은 다양한 용도의 패키지로 나뉘어 있어요.

• ptbk: 모든 패키지 번들 (용량 신경 안 쓸 때)
• @promptbook/wizzard: Node에서 Book을 쉽게 실행
• @promptbook/core: 핵심 로직
• @promptbook/node / browser: 각 환경별 코어
• @promptbook/utils: LLM 입출력 전처리/후처리 유틸
• @promptbook/markdown-utils: 마크다운 처리 유틸
• @promptbook/openai / anthropic-claude / google / deepseek / azure-openai: 각종 AI API 연동
• @promptbook/pdf / documents / legacy-documents / website-crawler: 다양한 문서/웹 크롤링 지원
• @promptbook/cli: 커맨드라인 도구
• Docker 이미지: 서버로 사용 가능

⭐️ 추천 패키지는 별표로 표시되어 있어요!

📚 용어 사전

LLM/AI 일반 용어

• Prompt drift: AI가 원래 의도와 다르게 결과를 내는 현상
• Pipeline/Workflow: 여러 작업을 순서대로 실행하는 구조
• Fine-tuning: 사전학습된 모델을 특정 데이터로 추가 학습
• Zero-shot/Few-shot learning: 예시 없이/적은 예시로 학습하는 방식
• Meta-learning: 다양한 작업을 빠르게 학습하는 능력
• Retrieval-augmented generation: 데이터베이스에서 정보를 찾아와 생성에 활용
• Longtail: 드물거나 희귀한 데이터

💯 핵심 개념

• 파이프라인 모음, 파이프라인, 작업, 페르소나, 파라미터, 실행, 기대값, 후처리, 단어 기반, 관심사 분리 등

고급 개념

• 지식(RAG), 원격 서버, 조건(Jokers), 메타프롬프트, 언어 타입, 자동 번역, 이미지/오디오/비디오, 기대값 인지 생성, JIT 파인튜닝, 이상 탐지, 에이전트 대립 기대값 등

🚂 Promptbook 엔진

• Book 언어로 작성된 앱을 실제로 실행하는 엔진이에요.
• 엔진 구조도 보기

➕➖ Promptbook, 언제 쓸까?

➕ 이런 경우에 좋아요!

• LLM으로 복잡한 결과물(웹사이트, 기사, 코드, 스토리 등)을 만들 때
• 코드와 프롬프트를 분리하고 싶을 때
• 복잡한 프롬프트 파이프라인을 코드 없이 설계하고 싶을 때
• 여러 프롬프트를 오케스트레이션하고 싶을 때
• 프롬프트 재사용, 버전 관리, 테스트, 실행 로그가 필요할 때

"복잡한 프롬프트를 코드로 직접 짜는 대신, 사람이 읽기 쉬운 언어로 설계하고 관리할 수 있습니다."

➖ 이런 경우엔 비추천

• 단일 간단 프롬프트만 필요할 때
• OpenAI Assistant(GPTs)만으로 충분할 때
• 스트리밍이 꼭 필요할 때 (추후 지원 예정)
• JavaScript/TypeScript 외 언어가 꼭 필요할 때 (추후 지원 예정)
• 이미지/오디오/비디오 등 비텍스트 중심일 때 (추후 지원 예정)
• 재귀(recursion)가 꼭 필요할 때

🐜 알려진 이슈

• 반복(Iteration) 미지원
• 임포트(Import) 미지원

🧼 의도적으로 미구현된 기능

• 재귀 없음
• 타입 없음(모든 값은 문자열)

❔ 자주 묻는 질문(FAQ)

• OpenAI SDK/Anthropic Claude SDK와 뭐가 달라요?
• OpenAI GPTs와 뭐가 달라요?
• Langchain, DSPy와 뭐가 달라요?
• Promptbook은 RAG(검색 기반 생성)인가요?
• 함수 호출(Function calling) 지원하나요?

궁금한 점은 디스커션 시작, 이슈 등록, 이메일 문의로 연락할 수 있어요.

⌚ 변경 이력

• CHANGELOG.md 참고

📜 라이선스

• BUSL 1.1 라이선스 (자세히 보기)

🎯 앞으로 할 일

• TODO.md 참고

🤝 파트너

• Promptbook Studio
• Technology Incubation

🖋️ 기여하기

• ⭐️ 프로젝트에 스타를 남기거나, GitHub 팔로우,
  기여 가이드 참고
• 풀리퀘스트, 피드백, 제안 모두 환영!

📞 지원

• 지원 리소스 참고

💡 요약 키워드

• Promptbook
• Book 언어
• 워크플로우/파이프라인
• 페르소나
• 지식/도구/액션
• 마크다운 기반
• AI 애플리케이션
• 프롬프트 관리/재사용/버전 관리
• LLM(대형 언어 모델)
• 오픈소스 생태계

"우리와 함께 이 여정에 동참하세요!" 🚀