forked from digitalgreenorg/DG_Open
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
698 lines (691 loc) · 27.9 KB
/
openapi.yaml
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
openapi: 3.0.0
info:
title: Farmer.Chat API Service
version: 1.0.0
description: >-
API endpoints for retrieving answers for farming related queries via text
and audio.
servers:
- url: 'https://api.yourdomain.com/api/'
description: Production server
paths:
/chat/get_answer_for_text_query/:
post:
summary: Get answer for text query
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email_id:
type: string
description: >-
Valid email address registered on FarmStack Content
Retrieval site.
example: [email protected]
query:
type: string
description: >-
Text query (question) related to Farming or agriculture from
the client expecting a relevant answer.
example: How to grow wheat?
responses:
'200':
description: Successful retrieval of response
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Successful retrieval of response for above query
query:
type: string
description: Current query or question submitted by the client.
example: How to grow wheat?
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
message_id:
type: string
description: >-
Message ID of the current query submitted by the client.
If message_id is available, it is to be submitted with the
specified subsequent API endpoints such as
/chat/synthesise_audio/
example: 10000000-0000-0000-0000-000000000000
response:
type: string
description: >-
Actual response or answer for the query processed by the
the app. This could also contain out of context response
for which the app may not contain the relevant content to
retrieve the answer for.
example: >-
Seems like you're interested in growing wheat effectively,
John! \n\nBased on the information in the context, here
are some tips for growing wheat effectively\u0003 Avoid
using fertilizers at certain stages of growth\n- Provide
adequate water, especially in areas with insufficient
rainfall.
follow_up_questions:
type: array
items:
oneOf:
follow_up_question_id:
type: string
description: ID of the Follow-up question generated.
example: 10000000-1000-0000-0000-000000000000
sequence:
type: int
description: Sequence of the Follow-up question generated.
example: 1
question:
type: string
description: generated question or query.
example: >-
How can I optimize irrigation practices to boost wheat
yields?
'401':
description: Unauthorized due to invalid email ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Invalid Email ID
query:
type: string
description: Current query or question submitted by the client.
example: How to grow wheat?
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
'500':
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Something went wrong
query:
type: string
description: Current query or question submitted by the client.
example: How to grow wheat?
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: true
/chat/synthesise_audio/:
post:
summary: Synthesise audio from text
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email_id:
type: string
description: >-
Valid email address registered on FarmStack Content
Retrieval site.
example: [email protected]
text:
type: string
description: >-
Actual response or the answer generated via the previous API
endpoint.
example: >-
Seems like you're interested in growing wheat effectively,
John! \n\nBased on the information in the context, here are
some tips for growing wheat effectively\u0003 Avoid using
fertilizers at certain stages of growth\n- Provide adequate
water, especially in areas with insufficient rainfall.
message_id:
type: string
description: Message ID via the previous API endpoint if available.
example: 10000000-0000-0000-0000-000000000000
responses:
'200':
description: Audio synthesis successful
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Audio synthesis successful
audio:
type: string
description: >-
Plaintext Base64 representation string of the processed or
synthesised audio from the request body of text. The audio will be in OGG OPUS encoding format at 48 kHZ
example: >-
T2dnUwACAAAAAAAAAAAAAAAAAAAAAENewaEBE09wdXNIZWFkAQE4AcBdAAAAAA
BPZ2dTAAAAAAAAAAAAAAAAAAABAAAASsI48gErT3B1c1RhZ3MbAAAAR29vZ2xl
IFNwZWVjaCB1c2luZyBsaWJvcHVzAAAAAE9nZ1MAAIC7AAAAAAAAAAAAAAIAAA
A5nwpbMn9FXGZfUVE/Pz9ATVFRU1xeWVlTUVBIRERIVVZbWVRWU2dDW2ZDX0RZ
VlFRUVFRRFBP2H ...
text:
type: string
description: Text message received via the request body
example: >-
Seems like you're interested in growing wheat effectively,
John! \n\nBased on the information in the context, here are
some tips for growing wheat effectively\u0003 Avoid using
fertilizers at certain stages of growth\n- Provide adequate
water, especially in areas with insufficient rainfall.
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
'401':
description: Unauthorized due to invalid email ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Invalid Email ID
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
'500':
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Something went wrong
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: true
/chat/transcribe_audio/:
post:
summary: Transcribe audio to text
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email_id:
type: string
description: >-
Valid email address registered on FarmStack Content
Retrieval site.
example: [email protected]
query:
type: string
description: >-
Plaintext Base64 representation of query (question) related
to Farming or agriculture from the client expecting a
relevant answer. The audio is expected to be in OGG OPUS encoding format at 48 kHZ
example: >-
T2dnUwACAAAAAAAAAAAAAAAAAAAAAEsaWJvcHVzAAAAAE9nZ1MAAEC/
AAAAAAAAAAAAAAIAAADrAzOsM31hP2BkTVdTU ...
query_language_bcp_code:
type: string
default: en-US
description: >-
BCP-47 language code of the audio query. The confidence of transcriptions directly depends on this value
example: es-US
responses:
'200':
description: Transcriptions generated successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Successful transcription for above input voice query.
heard_input_query:
type: string
description: >-
Base64 representation of Synthesised audio of heard_input_query
example: How to grow wheat?
heard_input_audio:
type: string
description: >-
Base64 representation of Synthesised audio of heard_input_query
example: >-
T2dnUwACAAAAAAAAAAAAAAAAAAAAAEsaWJvcHVzAAAAAE9nZ1MAAEC/
AAAAAAAAAAAAAAIAAADrAzOsM31hP2BkTVdTU ...
confidence_score:
type: number
description: >-
Confidence score of the detected audio in a specific or a
given language. Transcribed the audio into text only if
the score is above 0.7
example: 0.99
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
message_id:
type: string
description: Message ID via the previous API endpoint if available.
example: 20000000-0000-0000-0000-000000000000
'400':
description: Bad request due to invalid file or base64 string
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: >-
Unfortunately unable to transcribe the above voice input
query.
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
message_id:
type: string
example: 20000000-0000-0000-0000-000000000000
'401':
description: Unauthorized due to invalid email ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Invalid Email ID
error:
type: boolean
example: false
'500':
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Something went wrong
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: true
/chat/get_answer_by_voice_query/:
post:
summary: Get answer by processing voice query
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email_id:
type: string
description: >-
Valid email address registered on FarmStack
example: [email protected]
query:
type: string
description: >-
Plaintext Base64 representation of query (question) related
to Farming or agriculture from the client expecting a
relevant answer in OGG OPUS encoding format at 48 kHZ.
example: >-
T2dnUwACAAAAAAAAAAAAAAAAAAAAAEsaWJvcHVzAAAAAE9nZ1MAAEC/
AAAAAAAAAAAAAAIAAADrAzOsM31hP2BkTVdTU ...
query_language_bcp_code:
type: string
default: en-US
description: >-
Relevant human (spoken) language BCP47 code of the query
(Base64 representation query).
example: es-US
responses:
'200':
description: Voice query processed successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Successful transcription for above input voice query.
heard_input_query:
type: string
description: >-
transcribed text from the audio
example: How to grow wheat?
heard_input_audio:
type: string
description: >-
Base64 representation of Synthesised audio of heard_input_query
example: >-
T2dnUwACAAAAAAAAAAAAAAAAAAAAAEsaWJvcHVzAAAAAE9nZ1MAAEC/
AAAAAAAAAAAAAAIAAADrAzOsM31hP2BkTVdTU ...
confidence_score:
type: number
description: >-
Confidence score of the detected audio in a specific or a
given language. Synthesised the audio into text only if
the score is above 0.7
example: 0.99
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
message_id:
type: string
description: Message ID via the previous API endpoint if available.
example: 20000000-0000-0000-0000-000000000000
response:
type: string
description: >-
Actual response or answer for the query processed by the
the app. This could also contain out of context response
for which the app may not contain the relevant content to
retrieve the answer for.
example: >-
Seems like you're interested in growing wheat effectively,
John! \n\nBased on the information in the context, here
are some tips for growing wheat effectively\u0003 Avoid
using fertilizers at certain stages of growth\n- Provide
adequate water, especially in areas with insufficient
rainfall.
follow_up_questions:
type: array
items:
oneOf:
follow_up_question_id:
type: string
description: ID of the Follow-up question generated.
example: 10000000-1000-0000-0000-000000000000
sequence:
type: int
description: Sequence of the Follow-up question generated.
example: 1
question:
type: string
description: generated question or query.
example: >-
How can I optimize irrigation practices to boost wheat
yields?
'400':
description: Bad request due to invalid file or base64 string
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: >-
Unfortunately unable to transcribe the above voice input
query.
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
message_id:
type: string
example: 20000000-0000-0000-0000-000000000000
'401':
description: Unauthorized due to invalid email ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Invalid Email ID
error:
type: boolean
example: false
'500':
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Something went wrong
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: true
/language/languages/:
get:
summary: list supported languages
parameters:
- in: query
name: email_id
schema:
type: string
required: true
description: Valid email address registered on FarmStack Content Retrieval site.
example: [email protected]
responses:
'200':
description: Retrieved list of supported languages.
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Successful retrieval of supported language list.
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
language_data:
type: array
items:
oneOf:
language_id:
type: integer
description: ID of the language
example: 1
language_name:
type: string
description: Name of the language
example: Spanish
language_display_name:
type: string
description: Display name of the language
example: Español (Spanish)
language_code:
type: string
description: Two digit ISO 639-1 language code
example: es
language_latn_code:
type: string
description: >-
Language code of a specific local language written in
Latin script
example: es-Latn
language_bcp_code:
type: string
description: Language code for local accent of a specific language
example: es-ES
'401':
description: Unauthorized due to invalid email ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Invalid Email ID
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
/language/set_language/:
post:
summary: Save or set the client or user preferred language. This API will be useful when the Farmer.chat is used with database.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email_id:
type: string
description: >-
Valid email address registered on FarmStack Content
Retrieval site.
example: [email protected]
language_id:
type: integer
description: >-
Language ID fetched via the previous API endpoint
(/language/languages)
example: 10000000-0000-1000-0000-000000000000
responses:
'200':
description: Successfully saved client or user preferred language
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: >-
Saved the user's ([email protected]) preferred language
with Español (Spanish).
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
'400':
description: Bad request due to invalid file or base64 string
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Language with ID 50 does not exist.
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
'401':
description: Unauthorized due to invalid email ID
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Invalid Email ID
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: false
'500':
description: Internal server error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Status of the current API request as a text message.
example: Something went wrong
error:
type: boolean
description: >-
Error status if the API request fails other than bad
request.
example: true