-
Notifications
You must be signed in to change notification settings - Fork 829
/
assistant_v1.py
9594 lines (8457 loc) · 402 KB
/
assistant_v1.py
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
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# coding: utf-8
# (C) Copyright IBM Corp. 2019, 2020.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
The IBM Watson™ Assistant service combines machine learning, natural language
understanding, and an integrated dialog editor to create conversation flows between your
apps and your users.
The Assistant v1 API provides authoring methods your application can use to create or
update a workspace.
"""
import json
from ibm_cloud_sdk_core.authenticators.authenticator import Authenticator
from .common import get_sdk_headers
from datetime import datetime
from enum import Enum
from ibm_cloud_sdk_core import BaseService
from ibm_cloud_sdk_core import datetime_to_string, string_to_datetime
from ibm_cloud_sdk_core import get_authenticator_from_environment
from typing import Dict
from typing import List
##############################################################################
# Service
##############################################################################
class AssistantV1(BaseService):
"""The Assistant V1 service."""
DEFAULT_SERVICE_URL = 'https://gateway.watsonplatform.net/assistant/api'
DEFAULT_SERVICE_NAME = 'assistant'
def __init__(
self,
version: str,
authenticator: Authenticator = None,
service_name: str = DEFAULT_SERVICE_NAME,
) -> None:
"""
Construct a new client for the Assistant service.
:param str version: The API version date to use with the service, in
"YYYY-MM-DD" format. Whenever the API is changed in a backwards
incompatible way, a new minor version of the API is released.
The service uses the API version for the date you specify, or
the most recent version before that date. Note that you should
not programmatically specify the current date at runtime, in
case the API has been updated since your application's release.
Instead, specify a version date that is compatible with your
application, and don't change it until your application is
ready for a later version.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/master/README.md
about initializing the authenticator of your choice.
"""
if not authenticator:
authenticator = get_authenticator_from_environment(service_name)
BaseService.__init__(self,
service_url=self.DEFAULT_SERVICE_URL,
authenticator=authenticator,
disable_ssl_verification=False)
self.version = version
self.configure_service(service_name)
#########################
# Message
#########################
def message(self,
workspace_id: str,
*,
input: 'MessageInput' = None,
intents: List['RuntimeIntent'] = None,
entities: List['RuntimeEntity'] = None,
alternate_intents: bool = None,
context: 'Context' = None,
output: 'OutputData' = None,
nodes_visited_details: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Get response to user input.
Send user input to a workspace and receive a response.
**Important:** This method has been superseded by the new v2 runtime API. The v2
API offers significant advantages, including ease of deployment, automatic state
management, versioning, and search capabilities. For more information, see the
[documentation](https://cloud.ibm.com/docs/services/assistant?topic=assistant-api-overview).
There is no rate limit for this operation.
:param str workspace_id: Unique identifier of the workspace.
:param MessageInput input: (optional) An input object that includes the
input text.
:param List[RuntimeIntent] intents: (optional) Intents to use when
evaluating the user input. Include intents from the previous response to
continue using those intents rather than trying to recognize intents in the
new input.
:param List[RuntimeEntity] entities: (optional) Entities to use when
evaluating the message. Include entities from the previous response to
continue using those entities rather than detecting entities in the new
input.
:param bool alternate_intents: (optional) Whether to return more than one
intent. A value of `true` indicates that all matching intents are returned.
:param Context context: (optional) State information for the conversation.
To maintain state, include the context from the previous response.
:param OutputData output: (optional) An output object that includes the
response to the user, the dialog nodes that were triggered, and messages
from the log.
:param bool nodes_visited_details: (optional) Whether to include additional
diagnostic information about the dialog nodes that were visited during
processing of the message.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if input is not None:
input = self._convert_model(input)
if intents is not None:
intents = [self._convert_model(x) for x in intents]
if entities is not None:
entities = [self._convert_model(x) for x in entities]
if context is not None:
context = self._convert_model(context)
if output is not None:
output = self._convert_model(output)
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='message')
headers.update(sdk_headers)
params = {
'version': self.version,
'nodes_visited_details': nodes_visited_details
}
data = {
'input': input,
'intents': intents,
'entities': entities,
'alternate_intents': alternate_intents,
'context': context,
'output': output
}
url = '/v1/workspaces/{0}/message'.format(
*self._encode_path_vars(workspace_id))
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
#########################
# Workspaces
#########################
def list_workspaces(self,
*,
page_limit: int = None,
sort: str = None,
cursor: str = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
List workspaces.
List the workspaces associated with a Watson Assistant service instance.
This operation is limited to 500 requests per 30 minutes. For more information,
see **Rate limiting**.
:param int page_limit: (optional) The number of records to return in each
page of results.
:param str sort: (optional) The attribute by which returned workspaces will
be sorted. To reverse the sort order, prefix the value with a minus sign
(`-`).
:param str cursor: (optional) A token identifying the page of results to
retrieve.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='list_workspaces')
headers.update(sdk_headers)
params = {
'version': self.version,
'page_limit': page_limit,
'sort': sort,
'cursor': cursor,
'include_audit': include_audit
}
url = '/v1/workspaces'
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def create_workspace(self,
*,
name: str = None,
description: str = None,
language: str = None,
metadata: dict = None,
learning_opt_out: bool = None,
system_settings: 'WorkspaceSystemSettings' = None,
intents: List['CreateIntent'] = None,
entities: List['CreateEntity'] = None,
dialog_nodes: List['DialogNode'] = None,
counterexamples: List['Counterexample'] = None,
webhooks: List['Webhook'] = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Create workspace.
Create a workspace based on component objects. You must provide workspace
components defining the content of the new workspace.
This operation is limited to 30 requests per 30 minutes. For more information, see
**Rate limiting**.
:param str name: (optional) The name of the workspace. This string cannot
contain carriage return, newline, or tab characters.
:param str description: (optional) The description of the workspace. This
string cannot contain carriage return, newline, or tab characters.
:param str language: (optional) The language of the workspace.
:param dict metadata: (optional) Any metadata related to the workspace.
:param bool learning_opt_out: (optional) Whether training data from the
workspace (including artifacts such as intents and entities) can be used by
IBM for general service improvements. `true` indicates that workspace
training data is not to be used.
:param WorkspaceSystemSettings system_settings: (optional) Global settings
for the workspace.
:param List[CreateIntent] intents: (optional) An array of objects defining
the intents for the workspace.
:param List[CreateEntity] entities: (optional) An array of objects
describing the entities for the workspace.
:param List[DialogNode] dialog_nodes: (optional) An array of objects
describing the dialog nodes in the workspace.
:param List[Counterexample] counterexamples: (optional) An array of objects
defining input examples that have been marked as irrelevant input.
:param List[Webhook] webhooks: (optional)
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if system_settings is not None:
system_settings = self._convert_model(system_settings)
if intents is not None:
intents = [self._convert_model(x) for x in intents]
if entities is not None:
entities = [self._convert_model(x) for x in entities]
if dialog_nodes is not None:
dialog_nodes = [self._convert_model(x) for x in dialog_nodes]
if counterexamples is not None:
counterexamples = [self._convert_model(x) for x in counterexamples]
if webhooks is not None:
webhooks = [self._convert_model(x) for x in webhooks]
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='create_workspace')
headers.update(sdk_headers)
params = {'version': self.version, 'include_audit': include_audit}
data = {
'name': name,
'description': description,
'language': language,
'metadata': metadata,
'learning_opt_out': learning_opt_out,
'system_settings': system_settings,
'intents': intents,
'entities': entities,
'dialog_nodes': dialog_nodes,
'counterexamples': counterexamples,
'webhooks': webhooks
}
url = '/v1/workspaces'
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
def get_workspace(self,
workspace_id: str,
*,
export: bool = None,
include_audit: bool = None,
sort: str = None,
**kwargs) -> 'DetailedResponse':
"""
Get information about a workspace.
Get information about a workspace, optionally including all workspace content.
With **export**=`false`, this operation is limited to 6000 requests per 5 minutes.
With **export**=`true`, the limit is 20 requests per 30 minutes. For more
information, see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param bool export: (optional) Whether to include all element content in
the returned data. If **export**=`false`, the returned data includes only
information about the element itself. If **export**=`true`, all content,
including subelements, is included.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param str sort: (optional) Indicates how the returned workspace data will
be sorted. This parameter is valid only if **export**=`true`. Specify
`sort=stable` to sort all workspace objects by unique identifier, in
ascending alphabetical order.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='get_workspace')
headers.update(sdk_headers)
params = {
'version': self.version,
'export': export,
'include_audit': include_audit,
'sort': sort
}
url = '/v1/workspaces/{0}'.format(*self._encode_path_vars(workspace_id))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def update_workspace(self,
workspace_id: str,
*,
name: str = None,
description: str = None,
language: str = None,
metadata: dict = None,
learning_opt_out: bool = None,
system_settings: 'WorkspaceSystemSettings' = None,
intents: List['CreateIntent'] = None,
entities: List['CreateEntity'] = None,
dialog_nodes: List['DialogNode'] = None,
counterexamples: List['Counterexample'] = None,
webhooks: List['Webhook'] = None,
append: bool = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Update workspace.
Update an existing workspace with new or modified data. You must provide component
objects defining the content of the updated workspace.
This operation is limited to 30 request per 30 minutes. For more information, see
**Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str name: (optional) The name of the workspace. This string cannot
contain carriage return, newline, or tab characters.
:param str description: (optional) The description of the workspace. This
string cannot contain carriage return, newline, or tab characters.
:param str language: (optional) The language of the workspace.
:param dict metadata: (optional) Any metadata related to the workspace.
:param bool learning_opt_out: (optional) Whether training data from the
workspace (including artifacts such as intents and entities) can be used by
IBM for general service improvements. `true` indicates that workspace
training data is not to be used.
:param WorkspaceSystemSettings system_settings: (optional) Global settings
for the workspace.
:param List[CreateIntent] intents: (optional) An array of objects defining
the intents for the workspace.
:param List[CreateEntity] entities: (optional) An array of objects
describing the entities for the workspace.
:param List[DialogNode] dialog_nodes: (optional) An array of objects
describing the dialog nodes in the workspace.
:param List[Counterexample] counterexamples: (optional) An array of objects
defining input examples that have been marked as irrelevant input.
:param List[Webhook] webhooks: (optional)
:param bool append: (optional) Whether the new data is to be appended to
the existing data in the object. If **append**=`false`, elements included
in the new data completely replace the corresponding existing elements,
including all subelements. For example, if the new data for a workspace
includes **entities** and **append**=`false`, all existing entities in the
workspace are discarded and replaced with the new entities.
If **append**=`true`, existing elements are preserved, and the new elements
are added. If any elements in the new data collide with existing elements,
the update request fails.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if system_settings is not None:
system_settings = self._convert_model(system_settings)
if intents is not None:
intents = [self._convert_model(x) for x in intents]
if entities is not None:
entities = [self._convert_model(x) for x in entities]
if dialog_nodes is not None:
dialog_nodes = [self._convert_model(x) for x in dialog_nodes]
if counterexamples is not None:
counterexamples = [self._convert_model(x) for x in counterexamples]
if webhooks is not None:
webhooks = [self._convert_model(x) for x in webhooks]
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='update_workspace')
headers.update(sdk_headers)
params = {
'version': self.version,
'append': append,
'include_audit': include_audit
}
data = {
'name': name,
'description': description,
'language': language,
'metadata': metadata,
'learning_opt_out': learning_opt_out,
'system_settings': system_settings,
'intents': intents,
'entities': entities,
'dialog_nodes': dialog_nodes,
'counterexamples': counterexamples,
'webhooks': webhooks
}
url = '/v1/workspaces/{0}'.format(*self._encode_path_vars(workspace_id))
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
def delete_workspace(self, workspace_id: str,
**kwargs) -> 'DetailedResponse':
"""
Delete workspace.
Delete a workspace from the service instance.
This operation is limited to 30 requests per 30 minutes. For more information, see
**Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='delete_workspace')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v1/workspaces/{0}'.format(*self._encode_path_vars(workspace_id))
request = self.prepare_request(method='DELETE',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
#########################
# Intents
#########################
def list_intents(self,
workspace_id: str,
*,
export: bool = None,
page_limit: int = None,
sort: str = None,
cursor: str = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
List intents.
List the intents for a workspace.
With **export**=`false`, this operation is limited to 2000 requests per 30
minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For
more information, see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param bool export: (optional) Whether to include all element content in
the returned data. If **export**=`false`, the returned data includes only
information about the element itself. If **export**=`true`, all content,
including subelements, is included.
:param int page_limit: (optional) The number of records to return in each
page of results.
:param str sort: (optional) The attribute by which returned intents will be
sorted. To reverse the sort order, prefix the value with a minus sign
(`-`).
:param str cursor: (optional) A token identifying the page of results to
retrieve.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='list_intents')
headers.update(sdk_headers)
params = {
'version': self.version,
'export': export,
'page_limit': page_limit,
'sort': sort,
'cursor': cursor,
'include_audit': include_audit
}
url = '/v1/workspaces/{0}/intents'.format(
*self._encode_path_vars(workspace_id))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def create_intent(self,
workspace_id: str,
intent: str,
*,
description: str = None,
examples: List['Example'] = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Create intent.
Create a new intent.
If you want to create multiple intents with a single API call, consider using the
**[Update workspace](#update-workspace)** method instead.
This operation is limited to 2000 requests per 30 minutes. For more information,
see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str intent: The name of the intent. This string must conform to the
following restrictions:
- It can contain only Unicode alphanumeric, underscore, hyphen, and dot
characters.
- It cannot begin with the reserved prefix `sys-`.
:param str description: (optional) The description of the intent. This
string cannot contain carriage return, newline, or tab characters.
:param List[Example] examples: (optional) An array of user input examples
for the intent.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if intent is None:
raise ValueError('intent must be provided')
if examples is not None:
examples = [self._convert_model(x) for x in examples]
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='create_intent')
headers.update(sdk_headers)
params = {'version': self.version, 'include_audit': include_audit}
data = {
'intent': intent,
'description': description,
'examples': examples
}
url = '/v1/workspaces/{0}/intents'.format(
*self._encode_path_vars(workspace_id))
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
def get_intent(self,
workspace_id: str,
intent: str,
*,
export: bool = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Get intent.
Get information about an intent, optionally including all intent content.
With **export**=`false`, this operation is limited to 6000 requests per 5 minutes.
With **export**=`true`, the limit is 400 requests per 30 minutes. For more
information, see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str intent: The intent name.
:param bool export: (optional) Whether to include all element content in
the returned data. If **export**=`false`, the returned data includes only
information about the element itself. If **export**=`true`, all content,
including subelements, is included.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if intent is None:
raise ValueError('intent must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='get_intent')
headers.update(sdk_headers)
params = {
'version': self.version,
'export': export,
'include_audit': include_audit
}
url = '/v1/workspaces/{0}/intents/{1}'.format(
*self._encode_path_vars(workspace_id, intent))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def update_intent(self,
workspace_id: str,
intent: str,
*,
new_intent: str = None,
new_description: str = None,
new_examples: List['Example'] = None,
append: bool = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Update intent.
Update an existing intent with new or modified data. You must provide component
objects defining the content of the updated intent.
If you want to update multiple intents with a single API call, consider using the
**[Update workspace](#update-workspace)** method instead.
This operation is limited to 2000 requests per 30 minutes. For more information,
see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str intent: The intent name.
:param str new_intent: (optional) The name of the intent. This string must
conform to the following restrictions:
- It can contain only Unicode alphanumeric, underscore, hyphen, and dot
characters.
- It cannot begin with the reserved prefix `sys-`.
:param str new_description: (optional) The description of the intent. This
string cannot contain carriage return, newline, or tab characters.
:param List[Example] new_examples: (optional) An array of user input
examples for the intent.
:param bool append: (optional) Whether the new data is to be appended to
the existing data in the object. If **append**=`false`, elements included
in the new data completely replace the corresponding existing elements,
including all subelements. For example, if the new data for the intent
includes **examples** and **append**=`false`, all existing examples for the
intent are discarded and replaced with the new examples.
If **append**=`true`, existing elements are preserved, and the new elements
are added. If any elements in the new data collide with existing elements,
the update request fails.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if intent is None:
raise ValueError('intent must be provided')
if new_examples is not None:
new_examples = [self._convert_model(x) for x in new_examples]
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='update_intent')
headers.update(sdk_headers)
params = {
'version': self.version,
'append': append,
'include_audit': include_audit
}
data = {
'intent': new_intent,
'description': new_description,
'examples': new_examples
}
url = '/v1/workspaces/{0}/intents/{1}'.format(
*self._encode_path_vars(workspace_id, intent))
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
def delete_intent(self, workspace_id: str, intent: str,
**kwargs) -> 'DetailedResponse':
"""
Delete intent.
Delete an intent from a workspace.
This operation is limited to 2000 requests per 30 minutes. For more information,
see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str intent: The intent name.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if intent is None:
raise ValueError('intent must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='delete_intent')
headers.update(sdk_headers)
params = {'version': self.version}
url = '/v1/workspaces/{0}/intents/{1}'.format(
*self._encode_path_vars(workspace_id, intent))
request = self.prepare_request(method='DELETE',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
#########################
# Examples
#########################
def list_examples(self,
workspace_id: str,
intent: str,
*,
page_limit: int = None,
sort: str = None,
cursor: str = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
List user input examples.
List the user input examples for an intent, optionally including contextual entity
mentions.
This operation is limited to 2500 requests per 30 minutes. For more information,
see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str intent: The intent name.
:param int page_limit: (optional) The number of records to return in each
page of results.
:param str sort: (optional) The attribute by which returned examples will
be sorted. To reverse the sort order, prefix the value with a minus sign
(`-`).
:param str cursor: (optional) A token identifying the page of results to
retrieve.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if intent is None:
raise ValueError('intent must be provided')
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='list_examples')
headers.update(sdk_headers)
params = {
'version': self.version,
'page_limit': page_limit,
'sort': sort,
'cursor': cursor,
'include_audit': include_audit
}
url = '/v1/workspaces/{0}/intents/{1}/examples'.format(
*self._encode_path_vars(workspace_id, intent))
request = self.prepare_request(method='GET',
url=url,
headers=headers,
params=params)
response = self.send(request)
return response
def create_example(self,
workspace_id: str,
intent: str,
text: str,
*,
mentions: List['Mention'] = None,
include_audit: bool = None,
**kwargs) -> 'DetailedResponse':
"""
Create user input example.
Add a new user input example to an intent.
If you want to add multiple exaples with a single API call, consider using the
**[Update intent](#update-intent)** method instead.
This operation is limited to 1000 requests per 30 minutes. For more information,
see **Rate limiting**.
:param str workspace_id: Unique identifier of the workspace.
:param str intent: The intent name.
:param str text: The text of a user input example. This string must conform
to the following restrictions:
- It cannot contain carriage return, newline, or tab characters.
- It cannot consist of only whitespace characters.
:param List[Mention] mentions: (optional) An array of contextual entity
mentions.
:param bool include_audit: (optional) Whether to include the audit
properties (`created` and `updated` timestamps) in the response.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
"""
if workspace_id is None:
raise ValueError('workspace_id must be provided')
if intent is None:
raise ValueError('intent must be provided')
if text is None:
raise ValueError('text must be provided')
if mentions is not None:
mentions = [self._convert_model(x) for x in mentions]
headers = {}
if 'headers' in kwargs:
headers.update(kwargs.get('headers'))
sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME,
service_version='V1',
operation_id='create_example')
headers.update(sdk_headers)
params = {'version': self.version, 'include_audit': include_audit}
data = {'text': text, 'mentions': mentions}
url = '/v1/workspaces/{0}/intents/{1}/examples'.format(
*self._encode_path_vars(workspace_id, intent))
request = self.prepare_request(method='POST',
url=url,
headers=headers,
params=params,
data=data)
response = self.send(request)
return response
def get_example(self,
workspace_id: str,
intent: str,
text: str,
*,
include_audit: bool = None,