실시간 이벤트 API 개요

Live Events API는 Deeply 시스템이 감지한 오디오 이벤트를 실시간으로 제공합니다. 이 API는 WebSocket 연결을 사용해 이벤트 데이터를 지속적으로 스트리밍하므로, 클라이언트는 이벤트가 발생하는 즉시 모니터링할 수 있습니다.

WebSocket 엔드포인트#

ws://localhost:8100/api/v1/ws

• Protocol: WebSocket (ws)

이 페이지는 레퍼런스 전반에서 사용하는 로컬 기본 호스트를 기준으로 설명합니다.

클라이언트는 이 WebSocket 엔드포인트에 연결해 실시간 이벤트를 수신할 수 있습니다. 이 엔드포인트를 통해 전달되는 각 이벤트는 Event 객체 구조를 따르며, 감지된 오디오 이벤트에 대한 상세 정보를 제공합니다.

이벤트 데이터 형식#

각 WebSocket 메시지는 아래와 같은 JSON 객체 구조를 가집니다.

id#

• Type: string
• Description: 이벤트의 고유 식별자입니다.

label#

• Type: object
• Description: 감지된 소리에 대한 분류 정보입니다.
  • id (string): 음향 라벨의 고유 식별자
  • name (object): 라벨의 다국어 이름
    • ko (string): 한국어 이름
    • en (string): 영어 이름

confidence#

• Type: float
• Description: 감지 결과의 신뢰도 점수입니다. (0.0 ~ 1.0)

mic#

• Type: object
• Description: 소리를 기록한 장치 정보입니다.
  • id (string): 마이크의 고유 식별자
  • name (string): 마이크 이름
  • location (object): 장치의 지리적 위치
    • latitude (number): 위도 좌표
    • longitude (number): 경도 좌표

noises#

• Type: Array[float]
• Description: 데시벨(dB) 단위의 음압 레벨(SPL) 측정값 배열입니다.
• Details:
  • 각 값은 0.1초 간격으로 측정된 SPL 값을 나타냅니다.
  • 2초 길이의 오디오 클립이라면 배열에는 20개의 측정값이 포함됩니다.
  • 값은 일반적으로 30 dB(매우 조용함)에서 120 dB(매우 큼) 사이입니다.
  • 이벤트 지속 시간 동안의 음량 패턴을 분석할 때 유용합니다.

예시 응답#

{
  "id": "23d6ec74155f4eb187b4e7301b71b5d9",
  "label": {
    "id": "normal_speech_female",
    "name": {
      "ko": "대화(여성)",
      "en": "normal speech female"
    }
  },
  "confidence": 0.426632,
  "mic": {
    "id": "d00c8e3364a34439183e3462e773354a1",
    "name": "예시 마이크 (715)",
    "location": {
      "latitude": 37.546344,
      "longitude": 126.944322
    }
  },
  "noises": [
    66.99,
    65.28,
    68.21,
    68.12,
    67.56,
    70.66,
    67.35,
    63.42,
    59.98,
    64.05,
    65.86,
    62.88,
    62.41,
    62.59,
    61.96,
    59.25,
    58.16,
    59.75,
    64.2,
    65.15
  ]
}

이 예시에서 noises 배열은 2초 동안의 측정값 20개를 포함합니다. 값은 약 58 dB에서 71 dB 사이이며, 일반적인 대화 수준의 중간 정도 음량을 나타냅니다.