발음평가 기술 API 란?
최신 인공지능 기술에 기반하여 한국인을 비롯한 비원어민 영어 발성 및 외국인의 한국어 음성에 대해 높은 정확도의 음성인식 엔진과 높은 수준의 분석 알고리즘에
기반하여 문장별 발음 수준을 측정하여 제공합니다. 발음평가 API는 HTTP 기반의 REST API 인터페이스로 JSON 포맷 기반의 입력 및 출력을 지원하며 ETRI에서
제공하는 API Key 인증을 통해 사용할 수 있는 Open API 입니다.
API 호출 1일 허용량
| 기술명 | API명 | 1일 허용량 |
|---|---|---|
| 발음평가 기술 | 영어 발음평가 API | 1,000건/일 (60초 이내/건당) |
| 한국어 발음평가 API | 1,000건/일 (60초 이내/건당) |
발음평가 API 사용하기
발음평가 API는 REST API이며, 다의어 조회의 대상 어휘 데이터를 HTTP 통신으로 ETRI Open API 서버에 전달하면 됩니다. 서버가 제공하는 REST API의 URI는 다음과 같으며 POST 방식으로 호출해야 합니다.
http://epretx.etri.re.kr:8000/api/WiseASR_PronunciationKor
[HTTP Request Header]
"Authorization" : "YOUR_ACCESS_KEY"
[HTTP Request Body]
{
"request_id": "reserved field",
"argument": {
language_code": "LANGUAGE_CODE",
"script": "PRONUNCIATION_SCRIPT",
"audio": "BASE64_OF_AUDIO_DATA",
}
위와 같은 HTTP 요청을 e-PreTX 서버로 전달하면 서버는 JSON 형태의
Text 데이터를 HTTP 응답 메시지로 반환합니다. 다음은 HTTP 응답 예제 입니다.
[HTTP Response Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:0
Content-Type:application/json; charset=UTF-8
[HTTP Response Body]
{
"request_id": "reserved field",
"result": 0,
"return_type": "com.google.gson.internal.LinkedTreeMap",
"return_object": {발음평가 결과 JSON}
}음성인식용 안드로이드 앱 및 개발 환경
안드로이드 앱 제작에 참고가 가능한 소스코드 환경을 android studio 개발 환경으로 gitHub에 오픈하였으니 오픈 API를 사용한 app개발 시에 참고하시면 됩니다.
(Git에 올라와 있는 소스 코드는 리뉴얼 되기 전 버전입니다. 참고하시어 관련 소스 수정 하시기를 바랍니다.)
https://github.com/ETRISLP/EtriOpenASR
https://github.com/ETRISLP/EtriOpenASR
구현 예제(Python)
python 3.0을 기준으로 작성되었습니다.
HTTP 통신을 위해 urllib3 라이브러리를 사용하여 제공하고 있습니다. Python 3.0 이하의 버전에서
예제를 실행하기 위해서는 별도로 urllib3의 설치가 필요합니다.
설치에 대한 설명은 https://pypi.python.org/pypi/urllib3 를 참고하시기 바랍니다.
설치에 대한 설명은 https://pypi.python.org/pypi/urllib3 를 참고하시기 바랍니다.
urllib3 라이브러리에 대한 자세한 설명은 https://urllib3.readthedocs.io/en/latest/
에서 확인 하실 수 있습니다.
#-*- coding:utf-8 -*-
import urllib3
import json
openApiURL = "http://epretx.etri.re.kr:8000/api/WiseASR_PronunciationKor"
accessKey = "YOUR_ACCESS_KEY"
audioFilePath = "AUDIO_FILE_PATH"
languageCode = "LANGUAGE_CODE"
script = "PRONUNCIATION_SCRIPT"
requestJson = {
"argument": {
"language_code": languageCode,
script": script,
"audio": audioContents
}
}
http = urllib3.PoolManager()
response = http.request(
"POST",
openApiURL,
headers={"Content-Type": "application/json; charset=UTF-8","Authorization" : accessKey},
body=json.dumps(requestJson)
)
print("[responseCode]" + str(response.status))
print("[responBody]")
print(str(response.data,"utf-8"))
발음평가 레퍼런스
다음은
파라미터에 대한 설명입니다.
| Field 명 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| access_key | String | O | API 사용을 위해 ETRI에서 발급한 사용자 API Key 입니다. |
| argument | Object | O | API 사용 요청 시 분석을 위해 전달할 내용입니다. |
| language_code | String | O | 발음평가의
입력 음성 언어 코드입니다. 요청할 수 있는 언어 코드는 아래와 같습니다.
|
| script | String | 녹음된 음성파일의 제시 문장입니다. API 요청 시 script가 포함되지 않는 경우 비원어민 영어 음성인식을 수행한 이후 인식 결과에 대한 발음평가 점수를 제공합니다. | |
| audio | String | O | 발음평가를 할 녹음된 음성파일의 base64-encoded string 입니다. |
분석된 결과는 다음과 같은 내용이 포함되어 있습니다.
| JSON Key 이름 | 설명 |
|---|---|
| recognized | 음성 언어 코드에 따른 발음평가 결과 |
| score | 발음 평가 점수로 1~5점까지 제공 |
발음평가 API의 오류 코드 목록은 다음과 같습니다.
| http status code | result | reason | 설명 |
|---|---|---|---|
| 403 | -1 | Empty Auth Header | Authorization 헤더가 없는 경우 |
| 403 | -1 | Invalid Key | KEY
API 키가 없는 경우 |
| 403 |
-1 | Blocked KEY | API
키가 관리자에 의해서 차단된 경우 |
| 403 |
-1 | Daily Limit Exceeded | 일간 호출 제한에 걸린 경우 |
| 403 |
-1 | Monthly
Limit Exceeded |
월간 호출 제한에 걸린 경우 |
| 403 |
-1 | Yearly
Limit Exceeded |
연간 호출 제한에 걸린 경우 |
| 403 |
-1 | Too Many Keys | 같은 IP에서 여러 API 키가 사용된 경우 |
| 403 |
-1 | Too Many IPs | 하나의 API 키를 여러 IP 에서 사용한 경우 |
| 403 |
-1 | Not Allowed IP | API
호출 가능한 IP 가 아닌경우 (API 설정에서 허용된 IP가 아닌경우) |
| 403 |
-1 | Not Allowed Subpath | 하위경로 접근 제한이 되어 있는 경우 |
| 403 | -1 | Invalid
API |
등록되지
않은 API를 요청한 경우 |
| 408 | -1 |
Request
Timeout |
서버의
요청 대기가 시간을 초과한 경우 |
| 413 |
-1 | Body
Size Limit Exceeded |
요청
바디가 설정된 값보다 큰 경우 |
| 429 |
-1 | Concurrent
Limit Exceeded |
연속호출
허용 범위를 넘어서 호출한 경우 |
| 500 | -1 | Internal Server Error | 내부 오류 발생한 경우 |