Skip to main content

Long Denoiser API

해당 문서는 긴 미디어 파일에 대한 DeepHearing Denoiser API 문서입니다. Long Denoiser API를 통해 사용자는 파일 기반의 노이즈 제거를 진행할 수 있습니다. 비동기로 작동하여 처리 시간으로 인해 Short Denoiser API에서 노이즈 제거를 할 수 없던 긴 파일들을 처리할 수 있습니다.

Getting Started​

Long Denoiser API는 아래와 같이 동작합니다.

  1. API 인증 토큰과 함께 미디어 파일 업로드 주소를 요청합니다.
  2. 미디어 파일 업로드 주소에 파일을 업로드 합니다.
  3. 업로드된 미디어 파일의 처리 상태를 확인합니다.
  4. 완료 시 제공되는 URL을 통해 결과를 다운로드 받을 수 있습니다.

1. Media File API Request​

파일을 업로드 할 주소를 받아오는 요청입니다.

해당 요청을 통해 미디어 파일을 업로드할 주소와 함께 파일 처리 상태를 확인 할 수 있는 ID를 받을 수 있습니다.

단, URL 만료 시간 전까지 업로드를 해야합니다.

MethodURL
POSThttps://apigw.prod.deephearing.com/denoise-async/file

먼저 API 요청을 보내기 전에 미리 제공받은 API 키를 header에 추가해야 합니다.

Header
header = {
  'X-API-KEY': "<API_KEY>"
}

Response​

API 요청을 보내게 되면 아래와 같은 결과를 받을 수 있습니다.

Success
{
  "id": "<요청 ID>",
  "url": "<오디오 파일 업로드 주소>",
  "expires_at": "<URL 만료 시간>",
  "usageRemain": "<남은 사용량>"
}

2. Upload Media File​

이전 단계에서 받은 url로 파일을 업로드 하여 오디오 노이즈 제거를 진행할 수 있습니다. Short Denoiser API와 다르게 formdata 형식이 아닌 파일 형태로 업로드 해야 합니다.

업로드 된 파일은 AWS S3를 통해 안전하게 저장되며 일정 시간 이후 자동으로 삭제되어 사용자들의 파일 보안을 지키고 있습니다.

지원하는 오디오 파일은 지원 포맷을 참고해주세요.

import requests

url = "<1번 단계에서 받아온 url>"

payload = "<file contents here>"
headers = {
'Content-Type': 'audio/wave'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
주의

파일을 업로드는 1번 단계에서 받아온 url에 PUT 요청으로 보내야 합니다.

3. Check Media File Status​

이전 단계에서 반환받은 요청 ID를 url 파라미터로 넣어 요청을 보내면 해당 ID를 가진 요청의 처리상태를 확인할 수 있습니다.

MethodURL
POSThttps://apigw.prod.deephearing.com/denoise-async/status?id=<요청 ID>
Success
{
  "id": "<요청 ID>",
  "status": "<처리 상태>",
  "expires_at": "<2번 단계의 URL 만료 시간>"
}

처리상태의 타입은 아래와 같습니다.

  • pending : 미디어 파일 업로드 대기 상태
  • processing : 미디어 파일 노이즈 제거 진행 단계
  • done : 미디어 파일 노이즈 제거 완료 상태
  • failed : 미디어 파일 오류

4. Result File​

3번 단계에서 status가 done이 되었을 때 url을 포함하여 응답을 받을 수 있습니다.

Success
{
  "id": "<요청 ID>",
  "status": "<처리 상태>",
  "expires_at": "<노이즈 제거된 미디어 파일 URL 만료 시간>",
  "url":" <노이즈 제거된 미디어 파일 URL>"
}

status가 done이 되었을 때 만료시간은 노이즈가 제거된 미디어 파일의 url 만료시간이므로 만료시간이 되기 전에 미디어 파일을 다운받아야 합니다.

Support Media format​

Type
.wavrecommended
최근 업데이트 on