메인 콘텐츠로 건너뛰기

AmiVoice API 레퍼런스

AmiVoice API는 음성을 텍스트로 변환하는 음성 인식 Web API입니다. 이 레퍼런스에서는 동기식 HTTP 인터페이스, 비동기 HTTP 인터페이스, WebSocket 인터페이스 및 관련 API의 엔드포인트, 요청 파라미터, 응답, 프로토콜 사양을 설명합니다. HTTP API에 대해서는 OpenAPI 형식의 정의도 함께 제공합니다.

처음 사용하는 경우에는 매뉴얼의 시작하기부터 읽어 주십시오.

인터페이스의 종류​

음성 인식에는 용도에 따라 3가지 인터페이스가 있습니다. 각각의 차이점과 구분해서 사용하는 기준은 매뉴얼의 인터페이스의 종류와 사용법을 참조하십시오.

인터페이스용도
동기식 HTTP 인터페이스짧은 음성 파일(16MB 이하)을 HTTP POST로 전송하고 인식 결과를 동기적으로 받습니다. 구현이 가장 간단한 방법입니다.
비동기 HTTP 인터페이스장시간의 음성을 작업으로 등록하고 폴링으로 결과를 가져옵니다. 통화 녹음이나 회의 녹음의 배치 처리를 상정하고 있습니다. 화자 다이어라이제이션도 사용할 수 있습니다.
WebSocket 인터페이스WebSocket 연결 상의 양방향 통신 프로토콜로, 발화 중의 인식 중간 결과를 순차적으로 받을 수 있습니다. 실시간 자막 표시나 음성 대화에 적합합니다.

또한 음성 인식에 부수되는 다음 API를 제공하고 있습니다.

API용도
API Key 발급서비스 ID와 서비스 비밀번호로부터 유효기간이나 연결 원본 IP 주소 제한을 설정한 API key를 발급합니다.
사용자 사전 등록인식 정확도를 높이기 위한 단어 등록(단어 강조)의 가져오기·내보내기를 수행합니다.
단어 등록 클래스명단어 등록에 사용되는 클래스명 목록을 가져옵니다.
감정 파라미터 목록 가져오기감정 분석 결과에 포함되는 파라미터의 정의 목록을 가져옵니다.

HTTP를 사용하지 않고 애플리케이션에 통합하는 경우에는 각 언어 공통의 클라이언트 라이브러리(Hrp/Wrp)도 사용할 수 있습니다.

인증​

모든 API를 사용하려면 API key(서비스 인증 키 문자열)가 필요합니다.

API key 지정 방법​

  • 전 API 공통: 모든 API에서 HTTP 요청 헤더에 의한 인증이 가능합니다. 
    Authorization: Bearer {API_KEY}
  • 음성 인식 요청: 헤더 지정에 더해, 요청 파라미터(동기·비동기 HTTP의 경우 u 파라미터, WebSocket의 경우 s 명령어의 authorization 파라미터)로 설정할 수도 있습니다.

API key 취득·확인 절차​

자세한 내용은 매뉴얼의 API Key 발급 방법을 참조하십시오.

OpenAPI 정의​

HTTP API의 레퍼런스 페이지는 OpenAPI 형식의 정의 파일로부터 생성됩니다. 정의 파일(YAML)은 아래에서 다운로드할 수 있습니다.

관련 정보​