Skip to content

Commit db3d078

Browse files
maxnussbaumGERMAN ATTANASIO RUIZ
authored andcommitted
refactor(DetailedResponse): Change DetailedResponse.body to DetailedResponse.result
1 parent c8ba90f commit db3d078

31 files changed

+321
-321
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ response = assistant.headers(
183183
```
184184

185185
## Parsing HTTP response info
186-
HTTP requests all return `DetailedResponse` objects that have a `body`, `status`, and `headers`
186+
HTTP requests all return `DetailedResponse` objects that have a `result`, `status`, and `headers`
187187
```ruby
188188
require "ibm_watson"
189189
include IBMWatson
@@ -200,14 +200,14 @@ response = assistant.headers(
200200

201201
p "Status: #{response.status}"
202202
p "Headers: #{response.headers}"
203-
p "Body: #{response.body}"
203+
p "Result: #{response.result}"
204204
```
205205

206206
This would give an output of `DetailedResponse` having the structure:
207207
```ruby
208208
Status: 200
209209
Headers: <http response headers>
210-
Body: <response returned by service>
210+
Result: <response returned by service>
211211
```
212212

213213
## Using Websockets

examples/assistant_v1.rb

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
entities: create_workspace_data["entities"],
5858
counterexamples: create_workspace_data["counterexamples"],
5959
metadata: create_workspace_data["metadata"]
60-
).body
60+
).result
6161
p response
6262

6363
workspace_id = response["workspace_id"]
@@ -66,7 +66,7 @@
6666
response = assistant.get_workspace(
6767
workspace_id: workspace_id,
6868
export: true
69-
).body
69+
).result
7070
p response
7171

7272
# message
@@ -80,16 +80,16 @@
8080
"deployment" => "myDeployment"
8181
}
8282
}
83-
).body
83+
).result
8484
p response
8585

86-
response = assistant.list_workspaces.body
86+
response = assistant.list_workspaces.result
8787
p response
8888

8989
response = assistant.update_workspace(
9090
workspace_id: workspace_id,
9191
description: "Updated test workspace."
92-
).body
92+
).result
9393
p response
9494

9595
# see cleanup section below for delete_workspace example
@@ -104,28 +104,28 @@
104104
intent: "test_intent",
105105
description: "Test intent.",
106106
examples: examples
107-
).body
107+
).result
108108
p response
109109

110110
response = assistant.get_intent(
111111
workspace_id: workspace_id,
112112
intent: "test_intent",
113113
export: true
114-
).body
114+
).result
115115
p response
116116

117117
response = assistant.list_intents(
118118
workspace_id: workspace_id,
119119
export: true
120-
).body
120+
).result
121121
p response
122122

123123
response = assistant.update_intent(
124124
workspace_id: workspace_id,
125125
intent: "test_intent",
126126
new_intent: "updated_test_intent",
127127
new_description: "Updated test intent."
128-
).body
128+
).result
129129
p response
130130

131131
# see cleanup section below for delete_intent example
@@ -138,35 +138,35 @@
138138
workspace_id: workspace_id,
139139
intent: "updated_test_intent",
140140
text: "Gimme a pizza with pepperoni"
141-
).body
141+
).result
142142
p response
143143

144144
response = assistant.get_example(
145145
workspace_id: workspace_id,
146146
intent: "updated_test_intent",
147147
text: "Gimme a pizza with pepperoni"
148-
).body
148+
).result
149149
p response
150150

151151
response = assistant.list_examples(
152152
workspace_id: workspace_id,
153153
intent: "updated_test_intent"
154-
).body
154+
).result
155155
p response
156156

157157
response = assistant.update_example(
158158
workspace_id: workspace_id,
159159
intent: "updated_test_intent",
160160
text: "Gimme a pizza with pepperoni",
161161
new_text: "Gimme a pizza with pepperoni"
162-
).body
162+
).result
163163
p response
164164

165165
response = assistant.delete_example(
166166
workspace_id: workspace_id,
167167
intent: "updated_test_intent",
168168
text: "Gimme a pizza with pepperoni"
169-
).body
169+
).result
170170
p response
171171

172172
#########################
@@ -176,29 +176,29 @@
176176
response = assistant.create_counterexample(
177177
workspace_id: workspace_id,
178178
text: "I want financial advice today."
179-
).body
179+
).result
180180
p response
181181

182182
response = assistant.get_counterexample(
183183
workspace_id: workspace_id,
184184
text: "I want financial advice today."
185-
).body
185+
).result
186186
p response
187187

188-
response = assistant.list_counterexamples(workspace_id: workspace_id).body
188+
response = assistant.list_counterexamples(workspace_id: workspace_id).result
189189
p response
190190

191191
response = assistant.update_counterexample(
192192
workspace_id: workspace_id,
193193
text: "I want financial advice today.",
194194
new_text: "I want financial advice today."
195-
).body
195+
).result
196196
p response
197197

198198
response = assistant.delete_counterexample(
199199
workspace_id: workspace_id,
200200
text: "I want financial advice today."
201-
).body
201+
).result
202202
p response
203203

204204
#########################
@@ -211,7 +211,7 @@
211211
entity: "test_entity",
212212
description: "A test entity.",
213213
values: values
214-
).body
214+
).result
215215
p response
216216

217217
entities = [
@@ -253,30 +253,30 @@
253253
workspace_id: workspace_id,
254254
entity: entities[0]["entity"],
255255
values: entities[0]["values"]
256-
).body
256+
).result
257257
p response
258258

259259
response = assistant.get_entity(
260260
workspace_id: workspace_id,
261261
entity: entities[0]["entity"],
262262
export: true
263-
).body
263+
).result
264264
p response
265265

266-
response = assistant.list_entities(workspace_id: workspace_id).body
266+
response = assistant.list_entities(workspace_id: workspace_id).result
267267
p response
268268

269269
response = assistant.update_entity(
270270
workspace_id: workspace_id,
271271
entity: "test_entity",
272272
new_description: "An updated test entity."
273-
).body
273+
).result
274274
p response
275275

276276
response = assistant.delete_entity(
277277
workspace_id: workspace_id,
278278
entity: "test_entity"
279-
).body
279+
).result
280280
p response
281281

282282
#########################
@@ -295,22 +295,22 @@
295295
entity: "beverage",
296296
value: "orange juice",
297297
synonym: "oj"
298-
).body
298+
).result
299299
p response
300300

301301
response = assistant.get_synonym(
302302
workspace_id: workspace_id,
303303
entity: "beverage",
304304
value: "orange juice",
305305
synonym: "oj"
306-
).body
306+
).result
307307
p response
308308

309309
response = assistant.list_synonyms(
310310
workspace_id: workspace_id,
311311
entity: "beverage",
312312
value: "orange juice"
313-
).body
313+
).result
314314
p response
315315

316316
response = assistant.update_synonym(
@@ -319,15 +319,15 @@
319319
value: "orange juice",
320320
synonym: "oj",
321321
new_synonym: "OJ"
322-
).body
322+
).result
323323
p response
324324

325325
response = assistant.delete_synonym(
326326
workspace_id: workspace_id,
327327
entity: "beverage",
328328
value: "orange juice",
329329
synonym: "OJ"
330-
).body
330+
).result
331331
p response
332332

333333
assistant.delete_entity(workspace_id: workspace_id, entity: "beverage")
@@ -342,35 +342,35 @@
342342
workspace_id: workspace_id,
343343
entity: "test_entity",
344344
value: "test"
345-
).body
345+
).result
346346
p response
347347

348348
response = assistant.get_value(
349349
workspace_id: workspace_id,
350350
entity: "test_entity",
351351
value: "test"
352-
).body
352+
).result
353353
p response
354354

355355
response = assistant.list_values(
356356
workspace_id: workspace_id,
357357
entity: "test_entity"
358-
).body
358+
).result
359359
p response
360360

361361
response = assistant.update_value(
362362
workspace_id: workspace_id,
363363
entity: "test_entity",
364364
value: "test",
365365
new_value: "example"
366-
).body
366+
).result
367367
p response
368368

369369
response = assistant.delete_value(
370370
workspace_id: workspace_id,
371371
entity: "test_entity",
372372
value: "example"
373-
).body
373+
).result
374374
p response
375375

376376
assistant.delete_entity(workspace_id: workspace_id, entity: "test_entity")
@@ -396,33 +396,33 @@
396396
dialog_node: create_dialog_node["dialog_node"],
397397
description: create_dialog_node["description"],
398398
actions: create_dialog_node["actions"]
399-
).body
399+
).result
400400
p response
401401

402402
response = assistant.get_dialog_node(
403403
workspace_id: workspace_id,
404404
dialog_node: create_dialog_node["dialog_node"]
405-
).body
405+
).result
406406
p response
407407

408-
response = assistant.list_dialog_nodes(workspace_id: workspace_id).body
408+
response = assistant.list_dialog_nodes(workspace_id: workspace_id).result
409409
p response
410410

411411
response = assistant.update_dialog_node(
412412
workspace_id: workspace_id,
413413
dialog_node: create_dialog_node["dialog_node"],
414414
new_dialog_node: "updated_node"
415-
).body
415+
).result
416416
p response
417417

418-
response = assistant.delete_dialog_node(workspace_id: workspace_id, dialog_node: "updated_node").body
418+
response = assistant.delete_dialog_node(workspace_id: workspace_id, dialog_node: "updated_node").result
419419
p response
420420

421421
#########################
422422
# Logs
423423
#########################
424424

425-
response = assistant.list_logs(workspace_id: workspace_id).body
425+
response = assistant.list_logs(workspace_id: workspace_id).result
426426
p response
427427

428428
#########################
@@ -432,8 +432,8 @@
432432
response = assistant.delete_intent(
433433
workspace_id: workspace_id,
434434
intent: "updated_test_intent"
435-
).body
435+
).result
436436
p response
437437

438-
response = assistant.delete_workspace(workspace_id: workspace_id).body
438+
response = assistant.delete_workspace(workspace_id: workspace_id).result
439439
p response

0 commit comments

Comments
 (0)