Synthesizer

Synthesizer 인터페이스는 합성된 음성의 재생과 관련된 일련의 Message를 제공합니다.

Event

Event Message의 호출 방식은 다음과 같습니다.

SpeakReceived

Synthesizer.SpeakReceived는 Service Agent가 Synthesizer.Speak Instruction을 전송받자마자 KVS에 전송하는 Event입니다. 해당 Event는 필수적으로 전송되지 않으며, Service Agent의 필요 여부에 따라 선택적으로 전송됩니다.

Request Syntax

{
  "event": {
    "header": {
      "type": "Synthesizer.SpeakReceived",
      "messageId": "{STRING}"
    },
    "body": {
      "token": "{STRING}"
    }
  }
}

Request Header

Request Body

SpeakStarted

Synthesizer.SpeakStarted는 Service Agent가 Synthesizer.Speak Instruction을 처리하고 합성된 음성의 재생을 시작한 후에 KVS에 전송하는 Event입니다.

Request Syntax

코드예제Synthesizer.SpeakStarted Request Syntax

{
  "event": {
    "header": {
      "type": "Synthesizer.SpeakStarted",
      "messageId": "{STRING}"
    },
    "body": {
      "token": "{STRING}"
    }
  }
}

Request Header

Request Body

SpeakFinished

Synthesizer.SpeakFinished는 Service Agent가 Synthesizer.Speak Instruction을 처리하고 합성된 음성 재생을 완료 후 KVS로 전송하는 Event입니다.

Request Syntax

{
  "event": {
    "header": {
      "type": "Synthesizer.SpeakFinished",
      "messageId": "{STRING}"
    },
    "body": {
      "token": "{STRING}"
    }
  }
}

Request Header

Request Body

SpeakStopped

Synthesizer.SpeakStopped는 Service Agent가 Synthesizer.Speak Instruction을 처리하고 합성된 음성 재생이 완료되기 전에 중단되었을 경우 KVS로 전송하는 Event입니다.

Request Syntax

코드예제Synthesizer.SpeakStopped Request Syntax

{
  "event": {
    "header": {
      "type": "Synthesizer.SpeakStopped",
      "messageId": "{STRING}"
    },
    "body": {
      "token": "{STRING}"
    }
  }
}

Request Header

Request Body

TextToSpeech

Synthesizer.TextToSpeech는 Service Agent가 음성 변환이 필요한 텍스트를 KVS에 전달하는 Event입니다. KVS는 이에 대한 응답으로 Synthesizer.Speak Instruction을 전송합니다.

Request Syntax

코드예제Synthesizer.TextToSpeech Request Syntax

{
  "event": {
    "header": {
      "type": "Synthesizer.TextToSpeech",
      "messageId": "{STRING}"
    },
    "body": {
      "text": "{STRING}"
    }
  }
}

Request Header

Request Body

Instruction

Event Message의 응답으로 Instruction Message를 수신할 수도 있습니다. Instruction Message 수신을 위한 Down Channel 생성 방식은 다음과 같습니다.

Speak

Synthesizer.Speak는 MusicRecognizer.Recognize Event와 같이 Service Agent의 요청에 대해 음성 응답이 필요할 경우에 KVS가 Service Agent로 전송하는 Instruction입니다. 음성 응답 외에 Synthesizer.Speak Instruction을 통해 필요한 조치를 취할 수도 있습니다. 예를 들어, 사용자가 타이머 설정을 요청하면 Service Agent는 타이머가 성공적으로 설정되었음을 알려주는 Synthesizer.Speak Instruction을 수신합니다.

코드예제Synthesizer.Speak Request Syntax_The First Part

{
        "instruction": {
                "header": {
                        "type": "Synthesizer.Speak",
                        "messageId": "{STRING}",
                        "dialogRequestId": "{STRING}"
                },
                "body": {
                        "url": "{STRING}",
                        "format": "{STRING}",
                        "token": "{STRING}",
                        "mood": "{STRING}",
                        "hasWuw": {BOOLEAN},
                        "text": "{STRING}",
                        "action": "{STRING}"
                }
        }
}

코드예제Synthesizer.Speak Request Syntax_The Second Part(Binary Audio 첨부)

Content-Disposition: form-data; name="audio"
Content-Type: application/octet-stream
Content-ID: {Audio Item CID}

{BINARY AUDIO ATTACHMENT}

Request Header

Request Body

Stop

Synthesizer.Stop은 현재 재생 중인 음성 재생을 중지해야 할 때 KVS에서 Service Agent로 전송하는 Instruction입니다. Service Agent는 재생 중지를 수행한 후에 KVS로 Stopped Event를 전송합니다.

주의
Synthesizer.Stop 인터페이스는 1.1 버전부터 지원하고 있습니다.

• 지원하는 버전에 대한 자세한 설명은 Capability를 참고하시기 바랍니다.

Request Syntax

코드예제Synthesizer.Stop Request Syntax

{
  "instruction": {
    "header": {
      "type": "Synthesizer.Stop",
      "messageId": "{STRING}",
      "dialogRequestId": "{STRING}"
    },
    "body": {}
  }
}

Request Header

Request Body

Request Body는 없습니다.

State

State Message는 모든 Event Message를 전송하는 요청(Request)에 항상 포함되어야 합니다.

SpeakState

Synthesizer.SpeakState는 가장 최근에 발생한 아이템에 대한 정보를 전달하는 State입니다. 현재 재생되고 있는 아이템이 없을 경우에는 가장 마지막에 재생된 아이템 정보가 전달됩니다.

안내
이 값은 KVS에서 사용자의 Context를 추적할 때 사용됩니다.

Request Syntax

코드예제Synthesizer.SpeakState Request Syntax

{
  "header": {
    "type": "Synthesizer.SpeakState"
  },
  "body": {
    "token": "{STRING}",
    "state": "{STRING}"
  }
}

Request Header

Request Body