Add some descripsion

app.py

@@ -1,35 +1,50 @@
-import gradio as gr
-import requests
-import os
-from openai import OpenAI
+# 필요한 라이브러리 불러오기
+import gradio as gr       # Gradio: 웹 인터페이스 구성용 라이브러리
+import requests           # HTTP 요청 전송용 라이브러리 (API 호출에 사용)
+import os                 # 환경변수에서 API 키 불러오기 위해 사용
+from openai import OpenAI # Upstage Solar LLM 호출을 위한 OpenAI 호환 클라이언트
 
+# 환경 변수에서 API 키 불러오기 
 UPSTAGE_API_KEY = os.getenv("UPSTAGE_API_KEY")
 
 def parse_document(file):
-    url = "https://api.upstage.ai/v1/document-ai/document-parse"
-    headers = {'Authorization': f'Bearer {UPSTAGE_API_KEY}'}
-    files = {"document": open(file.name, "rb")}
+    """
+    업로드된 PDF 문서를 HTML로 변환하는 함수 (Upstage Document Parse API 사용)
+    """
+    url = "https://api.upstage.ai/v1/document-ai/document-parse"  # API URL
+    headers = {'Authorization': f'Bearer {UPSTAGE_API_KEY}'}      # 인증 헤더
+    files = {"document": open(file.name, "rb")}                   # 파일 열어서 바이너리로 전달
     data = {
-        "base64_encoding": "['table']",
-        "model": "document-parse"
+        "base64_encoding": "['table']",     # 테이블은 base64로 인코딩 요청
+        "model": "document-parse"           # 사용할 모델 지정
     }
 
+    # POST 요청으로 문서 분석 API 호출
     response = requests.post(url, headers=headers, files=files, data=data)
+
+    # 결과에서 HTML 콘텐츠 추출
     result = response.json()
     html_text = result.get("content", {}).get("html", "")
     return html_text
 
 def chat_with_document(history, html_text, user_question):
+    """
+    이전 대화기록을 바탕으로 사용자 질문에 대해 문서 기반 답변을 생성하는 멀티턴 챗봇 함수
+    """
     if not html_text.strip():
+        # 문서가 없을 경우 경고 메시지 반환
         return history, history, "⚠️ 먼저 문서를 변환해주세요."
 
+    # Clinet 호출 
     client = OpenAI(
         api_key=UPSTAGE_API_KEY,
         base_url="https://api.upstage.ai/v1"
     )
 
+    # 이전 채팅 기록이 없으면 빈 리스트로 초기화
     history = history or []
 
+    # 시스템 프롬프트 
     system_prompt = f"""The following is a financial statement document extracted in HTML format.
     Please answer user questions accurately and concisely in Korean, based on the text within HTML tags.
 
@@ -37,67 +52,85 @@ def chat_with_document(history, html_text, user_question):
     {html_text}
     """
 
+    # 대화 내역 구성 (시스템 → 이전 사용자 및 봇 대화 → 현재 질문)
     messages = [{"role": "system", "content": system_prompt}]
     for user, bot in history:
         messages.append({"role": "user", "content": user})
         messages.append({"role": "assistant", "content": bot})
     messages.append({"role": "user", "content": user_question})
 
+    # Solar Pro API 호출
     try:
         response = client.chat.completions.create(
-            model="solar-pro",
-            messages=messages,
-            temperature=0,
-            max_tokens=1024
+            model="solar-pro",            # 사용할 Solar LLM 모델
+            messages=messages,            # 구성된 대화 메시지들
+            temperature=0,                # 창의성 최소화 (정확한 답변 유도)
+            max_tokens=1024               # 최대 응답 길이
         )
-        bot_reply = response.choices[0].message.content
+        bot_reply = response.choices[0].message.content  # 응답 텍스트 추출
     except Exception as e:
-        bot_reply = f"⚠️ 오류가 발생했습니다: {str(e)}"
+        bot_reply = f"⚠️ 오류가 발생했습니다: {str(e)}"  # 예외 처리
 
+    # 채팅 기록에 질문/답변 추가
     history.append((user_question, bot_reply))
-    return history, history, ""
+    return history, history, ""  # 채팅 기록, 상태, 질문 입력칸 초기화
+
+
 
 def toggle_html_view(current_html, is_visible):
+    """
+    HTML 보기 버튼 클릭 시 보이기/숨기기 토글
+    """
     return (
-        gr.update(value=current_html, visible=not is_visible),
-        gr.update(value=current_html, visible=is_visible),
-        not is_visible
+        gr.update(value=current_html, visible=not is_visible),  # Textbox 토글
+        gr.update(value=current_html, visible=is_visible),      # HTML 뷰 토글
+        not is_visible                                           # 상태 반전
     )
 
 with gr.Blocks() as demo:
-
+    
+    # 상단 제목 및 설명 표시
     gr.Markdown("# 📄 재무제표 분석 챗봇")
     gr.Markdown("1. Document Parse API로 PDF 문서를 HTML로 변환합니다.\n"
                 "2. Solar LLM을 통해 문서 기반 질문에 답변합니다.")
     gr.Markdown("예제 파일은 Files 버튼을 클릭하면 확인 및 다운로드 가능합니다.")
 
+
+    # 파일 업로드 및 문서 파싱 영역
     with gr.Row():
-        file_input = gr.File(label="📎 재무제표 업로드")
-        parse_btn = gr.Button("문서 HTML 변환")
+        file_input = gr.File(label="📎 재무제표 업로드")  # 파일 업로드
+        parse_btn = gr.Button("문서 HTML 변환")           # 파싱 버튼
+
 
-    html_output = gr.Textbox(label="📘 문서 내용", lines=10, visible=True, elem_id="scrollable-html")
-    html_display = gr.HTML(visible=False, elem_id="scrollable-html-display")
-    toggle_html_btn = gr.Button("🔁 HTML 보기 전환")
-    html_visible_state = gr.State(False)
+    # HTML 출력 및 보기 토글
+    html_output = gr.Textbox(label="📘 문서 내용", lines=10, visible=True, elem_id="scrollable-html")  # 텍스트 형식
+    html_display = gr.HTML(visible=False, elem_id="scrollable-html-display")  # HTML 렌더링
+    toggle_html_btn = gr.Button("🔁 HTML 보기 전환")  # 보기 전환 버튼
+    html_visible_state = gr.State(False)             # 보기 상태 저장 (기본: 안 보임)
 
+    # 문서 변환 버튼 클릭 → HTML 출력
     parse_btn.click(fn=parse_document, inputs=file_input, outputs=html_output)
+
+    # 보기 전환 버튼 클릭 → 두 영역 토글
     toggle_html_btn.click(
         fn=toggle_html_view,
         inputs=[html_output, html_visible_state],
         outputs=[html_output, html_display, html_visible_state]
     )
 
-    chatbot = gr.Chatbot(label="💬 문서 기반 Q&A", height=400)
-    user_question = gr.Textbox(label="❓ 질문을 입력하세요", lines=2)
-    answer_btn = gr.Button("답변 생성")
-    chat_state = gr.State([])
+    # 문서 기반 챗봇 인터페이스
+    chatbot = gr.Chatbot(label="💬 문서 기반 Q&A", height=400)  # 채팅창
+    user_question = gr.Textbox(label="❓ 질문을 입력하세요", lines=2)  # 사용자 질문
+    answer_btn = gr.Button("답변 생성")  # 답변 버튼
+    chat_state = gr.State([])            # 채팅 상태 저장
 
+    # 예제 질문 버튼 
     with gr.Row():
         gr.Markdown("💡 예제 질문:")
         ex1 = gr.Button("어떤 기업의 재무제표인가요?")
         ex2 = gr.Button("3분기 총 순매출은 얼마인가요?")
 
-    # 예제 질문 → 질문 입력 + 자동 응답
+    # 예제 질문 1
     ex1.click(
         fn=lambda: "어떤 기업의 재무제표인가요?",
         inputs=[],
@@ -109,6 +142,7 @@ with gr.Blocks() as demo:
         show_progress=True
     )
 
+    # 예제 질문 2
     ex2.click(
         fn=lambda: "1분기 총 순매출은 얼마인가요?",
         inputs=[],
@@ -120,6 +154,7 @@ with gr.Blocks() as demo:
         show_progress=True
     )
 
+    # 사용자가 질문 입력 후 버튼 클릭 시 응답 생성
     answer_btn.click(
         fn=chat_with_document,
         inputs=[chat_state, html_output, user_question],
@@ -127,6 +162,7 @@ with gr.Blocks() as demo:
         show_progress=True
     )
 
+# 스크롤 가능한 HTML 영역 스타일 추가
 demo.css = """
 #scrollable-html, #scrollable-html-display {
     max-height: 400px;
@@ -136,4 +172,6 @@ demo.css = """
 }
 """
 
-demo.launch()
+# 앱 실행
+if __name__ == "__main__":
+    demo.launch()