hab-rs-api-client 0.3.0

Bindings for openHAB REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315

# \VoiceApi

All URIs are relative to */rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_default_voice**](VoiceApi.md#get_default_voice) | **GET** /voice/defaultvoice | Gets the default voice.
[**get_voice_interpreter_by_uid**](VoiceApi.md#get_voice_interpreter_by_uid) | **GET** /voice/interpreters/{id} | Gets a single interpreter.
[**get_voice_interpreters**](VoiceApi.md#get_voice_interpreters) | **GET** /voice/interpreters | Get the list of all interpreters.
[**get_voices**](VoiceApi.md#get_voices) | **GET** /voice/voices | Get the list of all voices.
[**interpret_text**](VoiceApi.md#interpret_text) | **POST** /voice/interpreters/{ids} | Sends a text to a given human language interpreter(s).
[**interpret_text_by_default_interpreter**](VoiceApi.md#interpret_text_by_default_interpreter) | **POST** /voice/interpreters | Sends a text to the default human language interpreter.
[**listen_and_answer**](VoiceApi.md#listen_and_answer) | **POST** /voice/listenandanswer | Executes a simple dialog sequence without keyword spotting for a given audio source.
[**start_dialog**](VoiceApi.md#start_dialog) | **POST** /voice/dialog/start | Start dialog processing for a given audio source.
[**stop_dialog**](VoiceApi.md#stop_dialog) | **POST** /voice/dialog/stop | Stop dialog processing for a given audio source.
[**text_to_speech**](VoiceApi.md#text_to_speech) | **POST** /voice/say | Speaks a given text with a given voice through the given audio sink.



## get_default_voice

> models::VoiceDto get_default_voice()
Gets the default voice.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::VoiceDto**](VoiceDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_voice_interpreter_by_uid

> Vec<models::HumanLanguageInterpreterDto> get_voice_interpreter_by_uid(id, accept_language)
Gets a single interpreter.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **String** | interpreter id | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<models::HumanLanguageInterpreterDto>**](HumanLanguageInterpreterDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_voice_interpreters

> Vec<models::HumanLanguageInterpreterDto> get_voice_interpreters(accept_language)
Get the list of all interpreters.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |

### Return type

[**Vec<models::HumanLanguageInterpreterDto>**](HumanLanguageInterpreterDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_voices

> Vec<models::VoiceDto> get_voices()
Get the list of all voices.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::VoiceDto>**](VoiceDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## interpret_text

> String interpret_text(ids, body, accept_language)
Sends a text to a given human language interpreter(s).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ids** | [**Vec<String>**](String.md) | comma separated list of interpreter ids | [required] |
**body** | **String** | text to interpret | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: text/plain
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## interpret_text_by_default_interpreter

> String interpret_text_by_default_interpreter(body, accept_language)
Sends a text to the default human language interpreter.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **String** | text to interpret | [required] |
**accept_language** | Option<**String**> | language |  |

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: text/plain
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## listen_and_answer

> listen_and_answer(accept_language, source_id, stt_id, tts_id, voice_id, hli_ids, sink_id, listening_item)
Executes a simple dialog sequence without keyword spotting for a given audio source.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |
**source_id** | Option<**String**> | source ID |  |
**stt_id** | Option<**String**> | Speech-to-Text ID |  |
**tts_id** | Option<**String**> | Text-to-Speech ID |  |
**voice_id** | Option<**String**> | voice ID |  |
**hli_ids** | Option<[**Vec<String>**](String.md)> | interpreter IDs |  |
**sink_id** | Option<**String**> | audio sink ID |  |
**listening_item** | Option<**String**> | listening item |  |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## start_dialog

> start_dialog(accept_language, source_id, ks_id, stt_id, tts_id, voice_id, hli_ids, sink_id, keyword, listening_item)
Start dialog processing for a given audio source.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**accept_language** | Option<**String**> | language |  |
**source_id** | Option<**String**> | source ID |  |
**ks_id** | Option<**String**> | keywork spotter ID |  |
**stt_id** | Option<**String**> | Speech-to-Text ID |  |
**tts_id** | Option<**String**> | Text-to-Speech ID |  |
**voice_id** | Option<**String**> | voice ID |  |
**hli_ids** | Option<**String**> | comma separated list of interpreter IDs |  |
**sink_id** | Option<**String**> | audio sink ID |  |
**keyword** | Option<**String**> | keyword |  |
**listening_item** | Option<**String**> | listening item |  |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## stop_dialog

> stop_dialog(source_id)
Stop dialog processing for a given audio source.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**source_id** | Option<**String**> | source ID |  |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## text_to_speech

> text_to_speech(body, voiceid, sinkid, volume)
Speaks a given text with a given voice through the given audio sink.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **String** | text to speak | [required] |
**voiceid** | Option<**String**> | voice id |  |
**sinkid** | Option<**String**> | audio sink id |  |
**volume** | Option<**String**> | volume level |  |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: text/plain
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)