84 lines
3.9 KiB
HTML
84 lines
3.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="ko">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>📄 공문 추출·번역 API 가이드</title>
|
|
<style>
|
|
body { font-family: 'Arial', sans-serif; margin: 40px; line-height: 1.6; }
|
|
h1, h2 { color: #2c3e50; }
|
|
code, pre { background: #f4f4f4; padding: 10px; display: block; white-space: pre-wrap; border-left: 4px solid #3498db; }
|
|
.warn { color: #c0392b; font-weight: bold; }
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>📄 문서 추출·번역 API 가이드</h1>
|
|
<p>
|
|
🔹 아래는 <strong>/extract</strong> 계열 API에 프롬프트를 작성하고 사용하는 방법에 대한 안내입니다.
|
|
</p>
|
|
|
|
<h3>📌 사용 가능한 API 종류</h3>
|
|
<P>
|
|
🔹 <strong>/extract/inner</strong>: 내부 모델을 사용<br>
|
|
🔹 <strong>/extract/outer</strong>: 외부 모델을 사용<br>
|
|
🔹 <strong>/extract/all</strong>: 내부 + 외부 모델을 동시에 사용<br>
|
|
🔹 <strong>/extract/structured</strong>: 고정된 JSON 필드로 정형 응답
|
|
</p>
|
|
|
|
<hr>
|
|
|
|
<h2>✅ "/extract/inner", "/extract/outer", "/extract/all"</h2>
|
|
<p>
|
|
🔹 문서 추출 항목을 다양하게 변경하며 시도할 경우에 사용합니다.<br>
|
|
🔹 해당 API의 업로드 파일은 2가지로 구성됩니다:
|
|
</p>
|
|
<img src="static/image/FastAPI_extract_swagger.png" width="600" style="border: 2px solid #ccc; border-radius: 4px;"/>
|
|
<h3>📌 API 첨부 파일 설명</h3>
|
|
<ul>
|
|
<li><strong>files</strong>: <span class="warn">(필수)</span> PDF, 이미지 등 추론 대상 파일을 업로드합니다.</li>
|
|
<li><strong>prompt_file</strong>: <span class="warn">(선택)</span> 질문이 포함된 질문이 포함된 프롬프트 텍스트(.txt)를 업로드합니다.
|
|
<ul>
|
|
<li><strong>업로드⭕</strong>: 사용자 정의 프롬프트 사용</li>
|
|
<li><strong>업로드❌</strong>: 내부에 정의된 기본 프롬프트를 사용</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<p class="warn">Tip. 프롬프트 업로드⭕ 경우, <strong>"JSON으로 작성해주세요"</strong> 문구는 자동으로 삽입되므로 직접 <strong>작성할 필요가 없습니다.</strong><p>
|
|
<p>→ 따라서, <strong>프롬프트 작성은 아래처럼 항목 설명만 작성</strong>하면 됩니다:</p>
|
|
|
|
<code> 1. 공문번호: 문서 번호를 기입하세요.
|
|
2. 공문일자: 공문 발행일을 작성하세요.
|
|
3. 수신처: 수신 기관이나 부서명을 작성하세요.
|
|
4. 수신자: 수신자의 이름 또는 직책을 기입하세요.
|
|
...</code>
|
|
|
|
<hr>
|
|
|
|
<h2>✅ "extract/structured"</h2>
|
|
<p>
|
|
🔹 문서 추출 항목을 고정하여 정해진 필드 형식으로 응답 받기 위해 사용합니다.<br>
|
|
🔹 해당 API의 업로드 파일은 3가지로 구성됩니다:
|
|
</p>
|
|
<img src="static/image/FastAPI_extract_structured_swagger.png" width="600" style="border: 2px solid #ccc; border-radius: 4px;"/>
|
|
<h3>📌 API 첨부 파일 설명</h3>
|
|
<ul>
|
|
<li><strong>files</strong>: <span class="warn">(필수)</span> PDF, 이미지 등 추론 대상 파일을 업로드합니다.</li>
|
|
<li><strong>schema_file</strong>: <span class="warn">(선택)</span> 응답 구조를 정의한 스키마 파일(.json)을 업로드합니다
|
|
<ul>
|
|
<li><strong>업로드⭕</strong>: 사용자 정의 필드 사용</li>
|
|
<li><strong>업로드❌</strong>: 내부에 정의된 기본 필드를 사용</li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>prompt_file</strong>: <span class="warn">(선택)</span> 질문이 포함된 질문이 포함된 프롬프트 텍스트(.txt)를 업로드합니다.
|
|
<ul>
|
|
<li><strong>업로드⭕</strong>: 사용자 정의 프롬프트 사용</li>
|
|
<li><strong>업로드❌</strong>: 내부에 정의된 기본 프롬프트를 사용</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<p class="warn">※ schemna json 작성은 "Guide Book" 첫 번째인 "schema_file_guide"를 참고해주세요.</p>
|
|
|
|
</body>
|
|
</html>
|