1
val chipsAgent = nuguAndroidClient.getAgent(ChipsAgent.NAMESPACE)
Version
최신 버전은 1.2 입니다.
Version | Date | Description |
---|---|---|
1.0 | 2020.07.02 | 규격 추가 |
1.1 | 2020.10.26 | Render directive 의 chips 에 token 필드 추가 |
1.2 | 2021.05.31 | Render directive 의 chips.type 에 NUDGE 추가 Render directive 의 target 에 LISTEN, SPEAKING 추가 |
SDK Interface
ChipsAgent 사용
Chips interface 규격에 따른 디바이스의 동작 제어는 ChipsAgent 가 처리합니다.
- Android
- iOS
- Linux
NuguAndroidClient instance 를 통해 ChipsAgent instance 에 접근할 수 있습니다.
보이스 크롬 UI 구성을 위해 TTS interface, ASR interface, Chips interface, Session interface 를 병합해주는 DialogUXStateAggregator 를 제공합니다.
NuguClient instance 를 통해 ChipsAgent instance 에 접근할 수 있습니다.
1
let chipsAgent = nuguClient.chipsAgent
보이스 크롬 UI 구성을 위해 TTS interface, ASR interface, Chips interface, Session interface 를 병합해주는 DisplayAggregatorInterface 를 제공합니다.
NuguClient instance 를 통해 DialogStateAggregator instance 에 접근할 수 있습니다.
1
let dialogStateAggregator = nuguClient.dialogStateAggregator
CapabilityFactory::makeCapability 함수로 ChipsAgent 를 생성하고 NuguClient 에 추가해 주어야합니다.
1
2
3
4
5
6
auto chips_handler(std::shared_ptr<IChipsHandler>(
CapabilityFactory::makeCapability<ChipsAgent, IChipsHandler>()));
nugu_client->getCapabilityBuilder()
->add(chips_handler.get())
->construct();
UI 구성
보이스 크롬에 노출하기 위한 데이터는 Render directive 에 포함되어 전달됩니다.
- Android
- iOS
- Linux
DialogUXStateAggregatorInterface.Listener 를 추가합니다.
1
2
3
4
5
6
val listener = object: DialogUXStateAggregatorInterface.Listener {
override fun onDialogUXStateChanged(newState: DialogUXState, dialogMode: Boolean, chips: RenderDirective.Payload?, sessionActivated: Boolean) {
...
}
}
nuguAndroidClient.addDialogUXStateListener(listener)
DialogStateDelegate 를 추가합니다.
1
2
3
4
5
6
class MyDialogStateDelegate: DialogStateDelegate {
func dialogStateDidChange(_ state: DialogState, isMultiturn: Bool, chips: [ChipsAgentItem.Chip]?, sessionActivated: Bool) {
...
}
}
dialogStateAggregator.add(delegate: MyDialogStateDelegate())
IChipsListener를 추가합니다.
1
2
3
4
5
6
7
8
9
10
11
class ChipsListener : public IChipsListener {
public:
...
void onReceiveRender(ChipsInfo&& chips_info) override
{
...
}
};
auto chips_listener(std::make_shared<IChipsListener>());
CapabilityFactory::makeCapability<ChipsAgent, IChipsHandler>(chips_listener.get());
Context
1
2
3
4
5
{
"Chips": {
"version": "1.2"
}
}
Directives
Render
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"header": {
"namespace": "Chips",
"name": "Render",
"messageId": "{{STRING}}",
"dialogRequestId": "{{STRING}}",
"version": "1.2"
},
"payload": {
"playServiceId": "{{STRING}}",
"target": "{{STRING}}",
"chips": [
{
"type": "{{STRING}}",
"text": "{{STRING}}",
"token": "{{STRING}}"
}
]
}
}
parameter | type | mandatory | description |
---|---|---|---|
target | string | Y |
DM : ASR.ExpectSpeech, Session.Set 와 같이 전달되는 발화가이드 LISTEN : Session.Set 없이 ASR.ExpectSpeech 발생 시 LISTEN 을 사용 SPEAKING : TTS.Speak 와 함께 제공되는 발화 가이드 |
chips | list | Y | 발화 가이드 목록 |
chips.type | string | Y |
ACTION : 보이스크롬 가이드의 ‘액션버튼’으로 기능 단위의 동작 처리를 위한 발화 가이드. GENERAL : 기본 발화 가이드 NUDGE : 넛지 발화 가이드 |
chips.text | string | Y | 버튼 텍스트 - Text.TextInput event 를 보내기 위한 텍스트 명령 문자열 |
chips.token | string | N | Text.TextInput event 의 출처를 구분하기 위한 값 |