forked from elevenlabs/elevenlabs-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclient.py
4953 lines (4311 loc) · 164 KB
/
client.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
# This file was auto-generated by Fern from our API Definition.
import typing
from ..core.client_wrapper import SyncClientWrapper
from ..core.request_options import RequestOptions
from ..types.conversation_signed_url_response_model import ConversationSignedUrlResponseModel
from ..core.unchecked_base_model import construct_type
from ..errors.unprocessable_entity_error import UnprocessableEntityError
from ..types.http_validation_error import HttpValidationError
from json.decoder import JSONDecodeError
from ..core.api_error import ApiError
from ..types.conversational_config import ConversationalConfig
from ..types.agent_platform_settings_request_model import AgentPlatformSettingsRequestModel
from ..types.create_agent_response_model import CreateAgentResponseModel
from ..core.serialization import convert_and_respect_annotation_metadata
from ..types.get_agent_response_model import GetAgentResponseModel
from ..core.jsonable_encoder import jsonable_encoder
from .types.body_patches_an_agent_settings_v_1_convai_agents_agent_id_patch_secrets_item import (
BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatchSecretsItem,
)
from ..types.get_agent_embed_response_model import GetAgentEmbedResponseModel
from ..types.get_agent_link_response_model import GetAgentLinkResponseModel
from .. import core
from ..types.post_agent_avatar_response_model import PostAgentAvatarResponseModel
from ..types.add_agent_secret_response_model import AddAgentSecretResponseModel
from ..types.get_agents_page_response_model import GetAgentsPageResponseModel
from ..types.evaluation_success_result import EvaluationSuccessResult
from ..types.get_conversations_page_response_model import GetConversationsPageResponseModel
from ..types.get_conversation_response_model import GetConversationResponseModel
from ..types.user_feedback_score import UserFeedbackScore
from ..types.create_phone_number_response_model import CreatePhoneNumberResponseModel
from ..types.get_phone_number_response_model import GetPhoneNumberResponseModel
from ..types.get_knowledge_base_list_response_model import GetKnowledgeBaseListResponseModel
from ..types.add_knowledge_base_response_model import AddKnowledgeBaseResponseModel
from ..types.get_knowledge_base_response_model import GetKnowledgeBaseResponseModel
from ..types.get_knowledge_base_dependent_agents_response_model import GetKnowledgeBaseDependentAgentsResponseModel
from ..types.tools_response_model import ToolsResponseModel
from ..types.tool_request_model import ToolRequestModel
from ..types.tool_response_model import ToolResponseModel
from ..types.get_convai_settings_response_model import GetConvaiSettingsResponseModel
from .types.patch_convai_settings_request_secrets_item import PatchConvaiSettingsRequestSecretsItem
from ..types.conversation_initiation_client_data_webhook import ConversationInitiationClientDataWebhook
from ..types.conv_ai_webhooks import ConvAiWebhooks
from ..types.get_workspace_secrets_response_model import GetWorkspaceSecretsResponseModel
from ..types.post_workspace_secret_response_model import PostWorkspaceSecretResponseModel
from ..core.client_wrapper import AsyncClientWrapper
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class ConversationalAiClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def get_signed_url(
self, *, agent_id: str, request_options: typing.Optional[RequestOptions] = None
) -> ConversationSignedUrlResponseModel:
"""
Get a signed url to start a conversation with an agent with an agent that requires authorization
Parameters
----------
agent_id : str
The id of the agent you're taking the action on.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ConversationSignedUrlResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_signed_url(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
"v1/convai/conversation/get_signed_url",
method="GET",
params={
"agent_id": agent_id,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
ConversationSignedUrlResponseModel,
construct_type(
type_=ConversationSignedUrlResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def create_agent(
self,
*,
conversation_config: ConversationalConfig,
use_tool_ids: typing.Optional[bool] = None,
platform_settings: typing.Optional[AgentPlatformSettingsRequestModel] = OMIT,
name: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> CreateAgentResponseModel:
"""
Create an agent from a config object
Parameters
----------
conversation_config : ConversationalConfig
Conversation configuration for an agent
use_tool_ids : typing.Optional[bool]
Use tool ids instead of tools specs from request payload.
platform_settings : typing.Optional[AgentPlatformSettingsRequestModel]
Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.
name : typing.Optional[str]
A name to make the agent easier to find
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
CreateAgentResponseModel
Successful Response
Examples
--------
from elevenlabs import ConversationalConfig, ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.create_agent(
conversation_config=ConversationalConfig(),
)
"""
_response = self._client_wrapper.httpx_client.request(
"v1/convai/agents/create",
method="POST",
params={
"use_tool_ids": use_tool_ids,
},
json={
"conversation_config": convert_and_respect_annotation_metadata(
object_=conversation_config, annotation=ConversationalConfig, direction="write"
),
"platform_settings": convert_and_respect_annotation_metadata(
object_=platform_settings, annotation=AgentPlatformSettingsRequestModel, direction="write"
),
"name": name,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
CreateAgentResponseModel,
construct_type(
type_=CreateAgentResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_agent(
self, agent_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> GetAgentResponseModel:
"""
Retrieve config for an agent
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetAgentResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_agent(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetAgentResponseModel,
construct_type(
type_=GetAgentResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def delete_agent(
self, agent_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Optional[typing.Any]:
"""
Delete an agent
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Optional[typing.Any]
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.delete_agent(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}",
method="DELETE",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
typing.Optional[typing.Any],
construct_type(
type_=typing.Optional[typing.Any], # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def update_agent(
self,
agent_id: str,
*,
use_tool_ids: typing.Optional[bool] = None,
conversation_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
platform_settings: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
secrets: typing.Optional[
typing.Sequence[BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatchSecretsItem]
] = OMIT,
name: typing.Optional[str] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> GetAgentResponseModel:
"""
Patches an Agent settings
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
use_tool_ids : typing.Optional[bool]
Use tool ids instead of tools specs from request payload.
conversation_config : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
Conversation configuration for an agent
platform_settings : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.
secrets : typing.Optional[typing.Sequence[BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatchSecretsItem]]
A list of secrets for the agent. Can be used to add new secrets or update and delete the existing ones
name : typing.Optional[str]
A name to make the agent easier to find
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetAgentResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.update_agent(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}",
method="PATCH",
params={
"use_tool_ids": use_tool_ids,
},
json={
"conversation_config": conversation_config,
"platform_settings": platform_settings,
"secrets": convert_and_respect_annotation_metadata(
object_=secrets,
annotation=typing.Sequence[BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatchSecretsItem],
direction="write",
),
"name": name,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetAgentResponseModel,
construct_type(
type_=GetAgentResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_agent_widget(
self,
agent_id: str,
*,
conversation_signature: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> GetAgentEmbedResponseModel:
"""
Retrieve the widget configuration for an agent
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
conversation_signature : typing.Optional[str]
An expiring token that enables a conversation to start. These can be generated for an agent using the /v1/convai/conversation/get_signed_url endpoint
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetAgentEmbedResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_agent_widget(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}/widget",
method="GET",
params={
"conversation_signature": conversation_signature,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetAgentEmbedResponseModel,
construct_type(
type_=GetAgentEmbedResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_agent_link(
self, agent_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> GetAgentLinkResponseModel:
"""
Get the current link used to share the agent with others
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetAgentLinkResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_agent_link(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}/link",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetAgentLinkResponseModel,
construct_type(
type_=GetAgentLinkResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def post_agent_avatar(
self, agent_id: str, *, avatar_file: core.File, request_options: typing.Optional[RequestOptions] = None
) -> PostAgentAvatarResponseModel:
"""
Sets the avatar for an agent displayed in the widget
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
avatar_file : core.File
See core.File for more documentation
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PostAgentAvatarResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.post_agent_avatar(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}/avatar",
method="POST",
data={},
files={
"avatar_file": avatar_file,
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
PostAgentAvatarResponseModel,
construct_type(
type_=PostAgentAvatarResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def add_agent_secret(
self, agent_id: str, *, name: str, secret_value: str, request_options: typing.Optional[RequestOptions] = None
) -> AddAgentSecretResponseModel:
"""
Uploads a file or reference a webpage for the agent to use as part of it's knowledge base
Parameters
----------
agent_id : str
The id of an agent. This is returned on agent creation.
name : str
A name to help identify a particular agent secret
secret_value : str
A value to be encrypted and used by the agent
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AddAgentSecretResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.add_agent_secret(
agent_id="21m00Tcm4TlvDq8ikWAM",
name="MY API KEY",
secret_value="sk_api_12354abc",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/agents/{jsonable_encoder(agent_id)}/add-secret",
method="POST",
json={
"name": name,
"secret_value": secret_value,
},
headers={
"content-type": "application/json",
},
request_options=request_options,
omit=OMIT,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
AddAgentSecretResponseModel,
construct_type(
type_=AddAgentSecretResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_agents(
self,
*,
cursor: typing.Optional[str] = None,
page_size: typing.Optional[int] = None,
search: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> GetAgentsPageResponseModel:
"""
Returns a page of your agents and their metadata.
Parameters
----------
cursor : typing.Optional[str]
Used for fetching next page. Cursor is returned in the response.
page_size : typing.Optional[int]
How many Agents to return at maximum. Can not exceed 100, defaults to 30.
search : typing.Optional[str]
Search by agents name.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetAgentsPageResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_agents()
"""
_response = self._client_wrapper.httpx_client.request(
"v1/convai/agents",
method="GET",
params={
"cursor": cursor,
"page_size": page_size,
"search": search,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetAgentsPageResponseModel,
construct_type(
type_=GetAgentsPageResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_conversations(
self,
*,
cursor: typing.Optional[str] = None,
agent_id: typing.Optional[str] = None,
call_successful: typing.Optional[EvaluationSuccessResult] = None,
page_size: typing.Optional[int] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> GetConversationsPageResponseModel:
"""
Get all conversations of agents that user owns. With option to restrict to a specific agent.
Parameters
----------
cursor : typing.Optional[str]
Used for fetching next page. Cursor is returned in the response.
agent_id : typing.Optional[str]
The id of the agent you're taking the action on.
call_successful : typing.Optional[EvaluationSuccessResult]
The result of the success evaluation
page_size : typing.Optional[int]
How many conversations to return at maximum. Can not exceed 100, defaults to 30.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetConversationsPageResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_conversations(
agent_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
"v1/convai/conversations",
method="GET",
params={
"cursor": cursor,
"agent_id": agent_id,
"call_successful": call_successful,
"page_size": page_size,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetConversationsPageResponseModel,
construct_type(
type_=GetConversationsPageResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_conversation(
self, conversation_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> GetConversationResponseModel:
"""
Get the details of a particular conversation
Parameters
----------
conversation_id : str
The id of the conversation you're taking the action on.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
GetConversationResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_conversation(
conversation_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/conversations/{jsonable_encoder(conversation_id)}",
method="GET",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
GetConversationResponseModel,
construct_type(
type_=GetConversationResponseModel, # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def delete_conversation(
self, conversation_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Optional[typing.Any]:
"""
Delete a particular conversation
Parameters
----------
conversation_id : str
The id of the conversation you're taking the action on.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Optional[typing.Any]
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.delete_conversation(
conversation_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/conversations/{jsonable_encoder(conversation_id)}",
method="DELETE",
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
return typing.cast(
typing.Optional[typing.Any],
construct_type(
type_=typing.Optional[typing.Any], # type: ignore
object_=_response.json(),
),
)
if _response.status_code == 422:
raise UnprocessableEntityError(
typing.cast(
HttpValidationError,
construct_type(
type_=HttpValidationError, # type: ignore
object_=_response.json(),
),
)
)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, body=_response.text)
raise ApiError(status_code=_response.status_code, body=_response_json)
def get_conversation_audio(
self, conversation_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> None:
"""
Get the audio recording of a particular conversation
Parameters
----------
conversation_id : str
The id of the conversation you're taking the action on.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
None
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_conversation_audio(
conversation_id="21m00Tcm4TlvDq8ikWAM",
)
"""
_response = self._client_wrapper.httpx_client.request(
f"v1/convai/conversations/{jsonable_encoder(conversation_id)}/audio",
method="GET",
request_options=request_options,