REST API

1. Introduction

다음은 HEARUS-AI-SERVING 프로젝트의 공식 API 문서입니다. 이 문서에서는 API 엔드포인트와 API 사용 방법에 대한 세부 사항을 확인할 수 있습니다.

2. Detailed API Documentation

각 API 엔드포인트는 특정 기능을 수행하며, 사용자는 이를 통해 서버와 상호작용할 수 있습니다. 모든 API는 HTTP 메소드를 통해 접근되며, 요청과 응답은 JSON 형식으로 이루어집니다. 아래는 각 API 엔드포인트에 대한 상세한 설명입니다.

이 문서는 클라이언트와 서버 간의 원활한 통신을 돕기 위한 가이드로, 각 엔드포인트의 역할, 필요한 요청 매개변수, 그리고 응답 형식을 포함합니다. 이를 통해 개발자는 보다 쉽게 API를 이해하고 사용할 수 있으며, 유지 보수 및 확장이 용이한 구조로 관리됩니다.

음성처리 결과 (문장 단위) LLM 처리

- 기본정보

HTTP Method	Endpoint
GET	/sttModification

- 요청

헤더

이름	타입	설명	필수
?text	String	LLM을 통해 처리할 문장	O

- 응답

- 예제

요청

http://127.0.0.1:8000/sttModification?text=경제학은 복잡한 경제 활동에서 특정한 아아아아 규칙성을 발견하여 경제 현상의 원인과 결과를 탐구하고 예측하는 것을 목표로

응답

"경제학은 경제 현상의 원인과 결과를 규명하고 예측하는 것을 목표로, 복잡한 경제 활동에서 특정한 규칙성을 발견하여 이를 탐구하고자 한다."

문제 생성

- 기본정보

HTTP Method	Endpoint
POST	/generateProblems

- 요청

본문

이름	타입	설명	필수
script	String	문제 생성을 위한 변환된 스크립트	O
subject	String	스크립트(강의)의 과목명	X
problem_num	Int	생성할 문제 개수	O
problem_types	String	문제 유형	O

- 예제

요청 Body

{
	"script" : "현대 주류경제학은 자원 등 경제적 가치가 있는 대상이 희소하고 이를 선택할 때에는 기회 비용이 발생한다는 것을 기본적인 전제로 한다. 경우에 따라서는 공기와 같은 것마저 공짜가 아니다.개인, 기업, 국가와 같은 경제 주체들은 시장에 참여하여 재화와 용역의 수요와 공급을 창출하고, 이 과정에서 최대한 이익이 되는 방향으로 행동하려한다. 따라서 경제 활동은 각 경제 주체가 가장 합리적인 선택을 하려는 경향성을 보이게 되고 이때문에 일정한 규칙이 성립하게 된다. 경제학은 이러한 경제 활동의 규칙을 찾고 이를 바탕으로 미래의 경제를 예측한다. 경제학은 현재의 상황을 분석하여 그 원인과 결과를 규명하는 실증경제학과 가치 판단에 따라 경제 활동을 평가하는 규범경제학으로 나뉠 수 있다. 한편, 경제학은 시장에 참여한 경제 주체의 활동을 연구대상으로 하는 미시경제학과 국가 단위 규모의 경제 활동과 정책을 연구 대상으로 하는 거시경제학으로 구분되기도 한다.",
	"subject" : "경제학",
	"problem_num" : "4",
	"problem_types" : "MultipleChoice,OXChoice"
}

응답

[
    {
        "type": "MultipleChoice",
        "direction": "현대 주류경제학의 기본적인 전제는?",
        "options": [
            "자원 등 경제적 가치가 있는 대상이 희소하고 이를 선택할 때에는 기회 비용이 발생한다.",
            "경제 주체들은 시장에 참여하여 재화와 용역의 수요와 공급을 창출하지 않는다.",
            "개인, 기업, 국가와 같은 경제 주체들이 가장 합리적인 선택을 하려는 경향성이 보이지 않는다.",
            "경제 활동은 각 경제 주체가 가장 비합리적인 선택을 하려는 경향성을 보이게 된다."
        ],
        "answer": 0
    },
    {
        "type": "OXChoice",
        "direction": "경제학은 시장에 참여한经济 주체의 활동을 연구대상으로 하는 미시경제학과国家 단위 규모의 경제 활동과 정책을 연구 대상으로 하는 거시경제학으로 구분되는가?",
        "options": [],
        "answer": 1
    },
    {
        "type": "MultipleChoice",
        "direction": "경제 활동은 각经济 주체가 가장 합리적인 선택을 하려는 경향성을 보이게 되고 이때문에 일정한 규칙이 성립하게 되는 이유는?",
        "options": [
            "자원 등 경제적 가치가 있는 대상이 희소하고 이를 선택할 때에는 기회 비용이 발생한다.",
            "경제 주체들은 시장에 참여하여 재화와 용역의 수요와 공급을 창출하지 않는다.",
            "개인, 기업, 국가와 같은经济 주체들이 가장 합리적인 선택을 하려는 경향성이 보이지 않는다.",
            "경제 활동은 각경제 주체가 가장 비합리적인 선택을 하려는 경향성을 보이게 된다."
        ],
        "answer": 0
    },
    {
        "type": "OXChoice",
        "direction": "현대 주류경제학은 자원 등 경제적 가치가 있는 대상이 공짜가 아니다?",
        "options": [],
        "answer": 1
    }
]

스크립트 재구조화

- 기본정보

HTTP Method	Endpoint
POST	/restructure_script

- 요청

본문

이름	타입	설명	필수
processedScript	Array[String]	재구조화를 위한 변환된 스크립트 배열	O

- 예제

요청 Body

{
    "processedScript" : [
    "이번 강의에서는 경제 정책의 두 가지 주요 도구인 재정 정책과 통화 정책에 대해 다루겠습니다.",
    "재정 정책은 정부 지출과 세금을 조절하여 경제를 관리하는 방법입니다.",
    "통화 정책은 중앙은행이 통화량과 이자율을 조절하여 경제 활동에 영향을 미치는 것을 말합니다.",
    "이 두 정책은 경제 성장 촉진, 실업률 감소, 인플레이션 관리 등 다양한 경제 목표를 달성하는 데 사용됩니다.",
    "재정 정책의 주요 수단으로는 정부 지출 증가와 감세가 있습니다.",
    "확장적 재정 정책은 경기 침체 시 경제를 자극하기 위해 사용됩니다.",
    "반면, 긴축적 재정 정책은 경제가 과열되었을 때 인플레이션을 억제하기 위해 사용됩니다.",
    "통화 정책의 주요 수단으로는 기준금리 조정, 지급준비율 변경, 공개시장조작 등이 있습니다.",
    "확장적 통화 정책은 금리를 낮추고 통화량을 늘려 경제 활동을 촉진합니다.",
    "긴축적 통화 정책은 금리를 올리고 통화량을 줄여 경제 성장을 억제합니다."
  ]
}

응답

{
    "processedScript": [
        "**이번 강의에서는** 경제 정책의 두 가지 주요 도구인 재정 정책과 통화 정책에 대해 다루겠습니다., **재정 정책은** 정부 지출과 세금을 조절하여 경제를 관리하는 방법입니다.",
        "**통화 정책은** 중앙은행이 통화량과 이자율을 조절하여 경제 활동에 영향을 미치는 것을 말합니다., 이 두 정책은 경제 성장 촉진, 실업률 감소, 인플레이션 관리 등 다양한 경제 목표를 달성하는 데 사용됩니다.",
        "**재정 정책의 주요 수단으로는** 정부 지출 증가와 감세가 있습니다., 확장적 재정 정책은 경기 침체 시 경제를 자극하기 위해 사용됩니다., 반면, 긴축적 재정 정책은 경제가 과열되었을 때 인플레이션을 억제하기 위해 사용됩니다.",
        "**통화 정책의 주요 수단으로는** 기준금리 조정, 지급준비율 변경, 공개시장조작 등이 있습니다., 확장적 통화 정책은 금리를 낮추고 통화량을 늘려 경제 활동을 촉진합니다., 긴축적 통화 정책은 금리를 올리고 통화량을 줄여 경제 성장을 억제합니다."
    ]
}