-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathagents.py
More file actions
1594 lines (1323 loc) · 62.6 KB
/
agents.py
File metadata and controls
1594 lines (1323 loc) · 62.6 KB
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
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
import time
import httpx
from .routes import (
RoutesResource,
AsyncRoutesResource,
RoutesResourceWithRawResponse,
AsyncRoutesResourceWithRawResponse,
RoutesResourceWithStreamingResponse,
AsyncRoutesResourceWithStreamingResponse,
)
from ...types import (
APIRetrievalMethod,
APIDeploymentVisibility,
agent_list_params,
agent_create_params,
agent_update_params,
agent_update_status_params,
agent_retrieve_usage_params,
)
from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
from ..._utils import maybe_transform, async_maybe_transform
from .api_keys import (
APIKeysResource,
AsyncAPIKeysResource,
APIKeysResourceWithRawResponse,
AsyncAPIKeysResourceWithRawResponse,
APIKeysResourceWithStreamingResponse,
AsyncAPIKeysResourceWithStreamingResponse,
)
from .versions import (
VersionsResource,
AsyncVersionsResource,
VersionsResourceWithRawResponse,
AsyncVersionsResourceWithRawResponse,
VersionsResourceWithStreamingResponse,
AsyncVersionsResourceWithStreamingResponse,
)
from ..._compat import cached_property
from .chat.chat import (
ChatResource,
AsyncChatResource,
ChatResourceWithRawResponse,
AsyncChatResourceWithRawResponse,
ChatResourceWithStreamingResponse,
AsyncChatResourceWithStreamingResponse,
)
from .functions import (
FunctionsResource,
AsyncFunctionsResource,
FunctionsResourceWithRawResponse,
AsyncFunctionsResourceWithRawResponse,
FunctionsResourceWithStreamingResponse,
AsyncFunctionsResourceWithStreamingResponse,
)
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ..._base_client import make_request_options
from .evaluation_runs import (
EvaluationRunsResource,
AsyncEvaluationRunsResource,
EvaluationRunsResourceWithRawResponse,
AsyncEvaluationRunsResourceWithRawResponse,
EvaluationRunsResourceWithStreamingResponse,
AsyncEvaluationRunsResourceWithStreamingResponse,
)
from .knowledge_bases import (
KnowledgeBasesResource,
AsyncKnowledgeBasesResource,
KnowledgeBasesResourceWithRawResponse,
AsyncKnowledgeBasesResourceWithRawResponse,
KnowledgeBasesResourceWithStreamingResponse,
AsyncKnowledgeBasesResourceWithStreamingResponse,
)
from .evaluation_datasets import (
EvaluationDatasetsResource,
AsyncEvaluationDatasetsResource,
EvaluationDatasetsResourceWithRawResponse,
AsyncEvaluationDatasetsResourceWithRawResponse,
EvaluationDatasetsResourceWithStreamingResponse,
AsyncEvaluationDatasetsResourceWithStreamingResponse,
)
from .evaluation_test_cases import (
EvaluationTestCasesResource,
AsyncEvaluationTestCasesResource,
EvaluationTestCasesResourceWithRawResponse,
AsyncEvaluationTestCasesResourceWithRawResponse,
EvaluationTestCasesResourceWithStreamingResponse,
AsyncEvaluationTestCasesResourceWithStreamingResponse,
)
from ...types.agent_list_response import AgentListResponse
from ...types.api_retrieval_method import APIRetrievalMethod
from ...types.agent_create_response import AgentCreateResponse
from ...types.agent_delete_response import AgentDeleteResponse
from ...types.agent_update_response import AgentUpdateResponse
from ...types.agent_retrieve_response import AgentRetrieveResponse
from ...types.api_deployment_visibility import APIDeploymentVisibility
from ...types.agent_update_status_response import AgentUpdateStatusResponse
from ...types.agent_retrieve_usage_response import AgentRetrieveUsageResponse
from .evaluation_metrics.evaluation_metrics import (
EvaluationMetricsResource,
AsyncEvaluationMetricsResource,
EvaluationMetricsResourceWithRawResponse,
AsyncEvaluationMetricsResourceWithRawResponse,
EvaluationMetricsResourceWithStreamingResponse,
AsyncEvaluationMetricsResourceWithStreamingResponse,
)
__all__ = ["AgentsResource", "AsyncAgentsResource"]
class AgentsResource(SyncAPIResource):
@cached_property
def api_keys(self) -> APIKeysResource:
return APIKeysResource(self._client)
@cached_property
def chat(self) -> ChatResource:
return ChatResource(self._client)
@cached_property
def evaluation_metrics(self) -> EvaluationMetricsResource:
return EvaluationMetricsResource(self._client)
@cached_property
def evaluation_runs(self) -> EvaluationRunsResource:
return EvaluationRunsResource(self._client)
@cached_property
def evaluation_test_cases(self) -> EvaluationTestCasesResource:
return EvaluationTestCasesResource(self._client)
@cached_property
def evaluation_datasets(self) -> EvaluationDatasetsResource:
return EvaluationDatasetsResource(self._client)
@cached_property
def functions(self) -> FunctionsResource:
return FunctionsResource(self._client)
@cached_property
def versions(self) -> VersionsResource:
return VersionsResource(self._client)
@cached_property
def knowledge_bases(self) -> KnowledgeBasesResource:
return KnowledgeBasesResource(self._client)
@cached_property
def routes(self) -> RoutesResource:
return RoutesResource(self._client)
@cached_property
def with_raw_response(self) -> AgentsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/digitalocean/gradient-python#accessing-raw-response-data-eg-headers
"""
return AgentsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AgentsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/digitalocean/gradient-python#with_streaming_response
"""
return AgentsResourceWithStreamingResponse(self)
def create(
self,
*,
anthropic_key_uuid: str | Omit = omit,
description: str | Omit = omit,
instruction: str | Omit = omit,
knowledge_base_uuid: SequenceNotStr[str] | Omit = omit,
model_provider_key_uuid: str | Omit = omit,
model_uuid: str | Omit = omit,
name: str | Omit = omit,
openai_key_uuid: str | Omit = omit,
project_id: str | Omit = omit,
region: str | Omit = omit,
tags: SequenceNotStr[str] | Omit = omit,
workspace_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentCreateResponse:
"""To create a new agent, send a POST request to `/v2/gen-ai/agents`.
The response
body contains a JSON object with the newly created agent object.
Args:
anthropic_key_uuid: Optional Anthropic API key ID to use with Anthropic models
description: A text description of the agent, not used in inference
instruction: Agent instruction. Instructions help your agent to perform its job effectively.
See
[Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
for best practices.
knowledge_base_uuid: Ids of the knowledge base(s) to attach to the agent
model_uuid: Identifier for the foundation model.
name: Agent name
openai_key_uuid: Optional OpenAI API key ID to use with OpenAI models
project_id: The id of the DigitalOcean project this agent will belong to
region: The DigitalOcean region to deploy your agent in
tags: Agent tag to organize related resources
workspace_uuid: Identifier for the workspace
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/v2/gen-ai/agents"
if self._client._base_url_overridden
else "https://api.digitalocean.com/v2/gen-ai/agents",
body=maybe_transform(
{
"anthropic_key_uuid": anthropic_key_uuid,
"description": description,
"instruction": instruction,
"knowledge_base_uuid": knowledge_base_uuid,
"model_provider_key_uuid": model_provider_key_uuid,
"model_uuid": model_uuid,
"name": name,
"openai_key_uuid": openai_key_uuid,
"project_id": project_id,
"region": region,
"tags": tags,
"workspace_uuid": workspace_uuid,
},
agent_create_params.AgentCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentCreateResponse,
)
def retrieve(
self,
uuid: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentRetrieveResponse:
"""To retrieve details of an agent, GET request to `/v2/gen-ai/agents/{uuid}`.
The
response body is a JSON object containing the agent.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not uuid:
raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
return self._get(
f"/v2/gen-ai/agents/{uuid}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{uuid}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentRetrieveResponse,
)
def update(
self,
path_uuid: str,
*,
agent_log_insights_enabled: bool | Omit = omit,
allowed_domains: SequenceNotStr[str] | Omit = omit,
anthropic_key_uuid: str | Omit = omit,
conversation_logs_enabled: bool | Omit = omit,
description: str | Omit = omit,
instruction: str | Omit = omit,
k: int | Omit = omit,
max_tokens: int | Omit = omit,
model_provider_key_uuid: str | Omit = omit,
model_uuid: str | Omit = omit,
name: str | Omit = omit,
openai_key_uuid: str | Omit = omit,
project_id: str | Omit = omit,
provide_citations: bool | Omit = omit,
retrieval_method: APIRetrievalMethod | Omit = omit,
tags: SequenceNotStr[str] | Omit = omit,
temperature: float | Omit = omit,
top_p: float | Omit = omit,
body_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentUpdateResponse:
"""To update an agent, send a PUT request to `/v2/gen-ai/agents/{uuid}`.
The
response body is a JSON object containing the agent.
Args:
allowed_domains: Optional list of allowed domains for the chatbot - Must use fully qualified
domain name (FQDN) such as https://example.com
anthropic_key_uuid: Optional anthropic key uuid for use with anthropic models
conversation_logs_enabled: Optional update of conversation logs enabled
description: Agent description
instruction: Agent instruction. Instructions help your agent to perform its job effectively.
See
[Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
for best practices.
k: How many results should be considered from an attached knowledge base
max_tokens: Specifies the maximum number of tokens the model can process in a single input
or output, set as a number between 1 and 512. This determines the length of each
response.
model_provider_key_uuid: Optional Model Provider uuid for use with provider models
model_uuid: Identifier for the foundation model.
name: Agent name
openai_key_uuid: Optional OpenAI key uuid for use with OpenAI models
project_id: The id of the DigitalOcean project this agent will belong to
retrieval_method: - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown
- RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite
- RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back
- RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries
- RETRIEVAL_METHOD_NONE: The retrieval method is none
tags: A set of abitrary tags to organize your agent
temperature: Controls the model’s creativity, specified as a number between 0 and 1. Lower
values produce more predictable and conservative responses, while higher values
encourage creativity and variation.
top_p: Defines the cumulative probability threshold for word selection, specified as a
number between 0 and 1. Higher values allow for more diverse outputs, while
lower values ensure focused and coherent responses.
body_uuid: Unique agent id
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not path_uuid:
raise ValueError(f"Expected a non-empty value for `path_uuid` but received {path_uuid!r}")
return self._put(
f"/v2/gen-ai/agents/{path_uuid}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{path_uuid}",
body=maybe_transform(
{
"agent_log_insights_enabled": agent_log_insights_enabled,
"allowed_domains": allowed_domains,
"anthropic_key_uuid": anthropic_key_uuid,
"conversation_logs_enabled": conversation_logs_enabled,
"description": description,
"instruction": instruction,
"k": k,
"max_tokens": max_tokens,
"model_provider_key_uuid": model_provider_key_uuid,
"model_uuid": model_uuid,
"name": name,
"openai_key_uuid": openai_key_uuid,
"project_id": project_id,
"provide_citations": provide_citations,
"retrieval_method": retrieval_method,
"tags": tags,
"temperature": temperature,
"top_p": top_p,
"body_uuid": body_uuid,
},
agent_update_params.AgentUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentUpdateResponse,
)
def list(
self,
*,
only_deployed: bool | Omit = omit,
page: int | Omit = omit,
per_page: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentListResponse:
"""
To list all agents, send a GET request to `/v2/gen-ai/agents`.
Args:
only_deployed: Only list agents that are deployed.
page: Page number.
per_page: Items per page.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
"/v2/gen-ai/agents"
if self._client._base_url_overridden
else "https://api.digitalocean.com/v2/gen-ai/agents",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"only_deployed": only_deployed,
"page": page,
"per_page": per_page,
},
agent_list_params.AgentListParams,
),
),
cast_to=AgentListResponse,
)
def delete(
self,
uuid: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentDeleteResponse:
"""
To delete an agent, send a DELETE request to `/v2/gen-ai/agents/{uuid}`.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not uuid:
raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
return self._delete(
f"/v2/gen-ai/agents/{uuid}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{uuid}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentDeleteResponse,
)
def retrieve_usage(
self,
uuid: str,
*,
start: str | Omit = omit,
stop: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentRetrieveUsageResponse:
"""
To get agent usage, send a GET request to `/v2/gen-ai/agents/{uuid}/usage`.
Returns usage metrics for the specified agent within the provided time range.
Args:
start: Return all usage data from this date.
stop: Return all usage data up to this date, if omitted, will return up to the current
date.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not uuid:
raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
return self._get(
f"/v2/gen-ai/agents/{uuid}/usage"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{uuid}/usage",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"start": start,
"stop": stop,
},
agent_retrieve_usage_params.AgentRetrieveUsageParams,
),
),
cast_to=AgentRetrieveUsageResponse,
)
def update_status(
self,
path_uuid: str,
*,
body_uuid: str | Omit = omit,
visibility: APIDeploymentVisibility | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentUpdateStatusResponse:
"""Check whether an agent is public or private.
To update the agent status, send a
PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`.
Args:
body_uuid: Unique id
visibility: - VISIBILITY_UNKNOWN: The status of the deployment is unknown
- VISIBILITY_DISABLED: The deployment is disabled and will no longer service
requests
- VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
- VISIBILITY_PUBLIC: The deployment is public and will service requests from the
public internet
- VISIBILITY_PRIVATE: The deployment is private and will only service requests
from other agents, or through API keys
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not path_uuid:
raise ValueError(f"Expected a non-empty value for `path_uuid` but received {path_uuid!r}")
return self._put(
f"/v2/gen-ai/agents/{path_uuid}/deployment_visibility"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{path_uuid}/deployment_visibility",
body=maybe_transform(
{
"body_uuid": body_uuid,
"visibility": visibility,
},
agent_update_status_params.AgentUpdateStatusParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentUpdateStatusResponse,
)
def wait_until_ready(
self,
uuid: str,
*,
timeout: float = 300.0,
poll_interval: float = 5.0,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
) -> AgentRetrieveResponse:
"""Wait for an agent to be ready (deployment status is STATUS_RUNNING).
This method polls the agent status until it reaches STATUS_RUNNING or a terminal
error state. It handles timeout and deployment failures automatically.
Args:
uuid: The unique identifier of the agent to wait for
timeout: Maximum time to wait in seconds (default: 300 seconds / 5 minutes)
poll_interval: Time to wait between status checks in seconds (default: 5 seconds)
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
Returns:
AgentRetrieveResponse: The agent response when it reaches STATUS_RUNNING
Raises:
AgentDeploymentError: If the agent deployment fails (STATUS_FAILED,
STATUS_UNDEPLOYMENT_FAILED, or STATUS_DELETED)
AgentDeploymentTimeoutError: If the agent doesn't reach STATUS_RUNNING
within the timeout period
ValueError: If uuid is empty
"""
from ..._exceptions import AgentDeploymentError, AgentDeploymentTimeoutError
if not uuid:
raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
start_time = time.time()
while True:
agent_response = self.retrieve(
uuid,
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
)
# Check if agent and deployment exist
if agent_response.agent and agent_response.agent.deployment:
status = agent_response.agent.deployment.status
# Success case
if status == "STATUS_RUNNING":
return agent_response
# Failure cases
if status in ("STATUS_FAILED", "STATUS_UNDEPLOYMENT_FAILED", "STATUS_DELETED"):
raise AgentDeploymentError(
f"Agent deployment failed with status: {status}",
status=status,
)
# Check timeout
elapsed_time = time.time() - start_time
if elapsed_time >= timeout:
current_status = (
agent_response.agent.deployment.status
if agent_response.agent and agent_response.agent.deployment
else "UNKNOWN"
)
raise AgentDeploymentTimeoutError(
f"Agent did not reach STATUS_RUNNING within {timeout} seconds. Current status: {current_status}",
agent_id=uuid,
)
# Wait before polling again
time.sleep(poll_interval)
class AsyncAgentsResource(AsyncAPIResource):
@cached_property
def api_keys(self) -> AsyncAPIKeysResource:
return AsyncAPIKeysResource(self._client)
@cached_property
def chat(self) -> AsyncChatResource:
return AsyncChatResource(self._client)
@cached_property
def evaluation_metrics(self) -> AsyncEvaluationMetricsResource:
return AsyncEvaluationMetricsResource(self._client)
@cached_property
def evaluation_runs(self) -> AsyncEvaluationRunsResource:
return AsyncEvaluationRunsResource(self._client)
@cached_property
def evaluation_test_cases(self) -> AsyncEvaluationTestCasesResource:
return AsyncEvaluationTestCasesResource(self._client)
@cached_property
def evaluation_datasets(self) -> AsyncEvaluationDatasetsResource:
return AsyncEvaluationDatasetsResource(self._client)
@cached_property
def functions(self) -> AsyncFunctionsResource:
return AsyncFunctionsResource(self._client)
@cached_property
def versions(self) -> AsyncVersionsResource:
return AsyncVersionsResource(self._client)
@cached_property
def knowledge_bases(self) -> AsyncKnowledgeBasesResource:
return AsyncKnowledgeBasesResource(self._client)
@cached_property
def routes(self) -> AsyncRoutesResource:
return AsyncRoutesResource(self._client)
@cached_property
def with_raw_response(self) -> AsyncAgentsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/digitalocean/gradient-python#accessing-raw-response-data-eg-headers
"""
return AsyncAgentsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncAgentsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/digitalocean/gradient-python#with_streaming_response
"""
return AsyncAgentsResourceWithStreamingResponse(self)
async def create(
self,
*,
anthropic_key_uuid: str | Omit = omit,
description: str | Omit = omit,
instruction: str | Omit = omit,
knowledge_base_uuid: SequenceNotStr[str] | Omit = omit,
model_provider_key_uuid: str | Omit = omit,
model_uuid: str | Omit = omit,
name: str | Omit = omit,
openai_key_uuid: str | Omit = omit,
project_id: str | Omit = omit,
region: str | Omit = omit,
tags: SequenceNotStr[str] | Omit = omit,
workspace_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentCreateResponse:
"""To create a new agent, send a POST request to `/v2/gen-ai/agents`.
The response
body contains a JSON object with the newly created agent object.
Args:
anthropic_key_uuid: Optional Anthropic API key ID to use with Anthropic models
description: A text description of the agent, not used in inference
instruction: Agent instruction. Instructions help your agent to perform its job effectively.
See
[Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
for best practices.
knowledge_base_uuid: Ids of the knowledge base(s) to attach to the agent
model_uuid: Identifier for the foundation model.
name: Agent name
openai_key_uuid: Optional OpenAI API key ID to use with OpenAI models
project_id: The id of the DigitalOcean project this agent will belong to
region: The DigitalOcean region to deploy your agent in
tags: Agent tag to organize related resources
workspace_uuid: Identifier for the workspace
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/v2/gen-ai/agents"
if self._client._base_url_overridden
else "https://api.digitalocean.com/v2/gen-ai/agents",
body=await async_maybe_transform(
{
"anthropic_key_uuid": anthropic_key_uuid,
"description": description,
"instruction": instruction,
"knowledge_base_uuid": knowledge_base_uuid,
"model_provider_key_uuid": model_provider_key_uuid,
"model_uuid": model_uuid,
"name": name,
"openai_key_uuid": openai_key_uuid,
"project_id": project_id,
"region": region,
"tags": tags,
"workspace_uuid": workspace_uuid,
},
agent_create_params.AgentCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentCreateResponse,
)
async def retrieve(
self,
uuid: str,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentRetrieveResponse:
"""To retrieve details of an agent, GET request to `/v2/gen-ai/agents/{uuid}`.
The
response body is a JSON object containing the agent.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not uuid:
raise ValueError(f"Expected a non-empty value for `uuid` but received {uuid!r}")
return await self._get(
f"/v2/gen-ai/agents/{uuid}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{uuid}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=AgentRetrieveResponse,
)
async def update(
self,
path_uuid: str,
*,
agent_log_insights_enabled: bool | Omit = omit,
allowed_domains: SequenceNotStr[str] | Omit = omit,
anthropic_key_uuid: str | Omit = omit,
conversation_logs_enabled: bool | Omit = omit,
description: str | Omit = omit,
instruction: str | Omit = omit,
k: int | Omit = omit,
max_tokens: int | Omit = omit,
model_provider_key_uuid: str | Omit = omit,
model_uuid: str | Omit = omit,
name: str | Omit = omit,
openai_key_uuid: str | Omit = omit,
project_id: str | Omit = omit,
provide_citations: bool | Omit = omit,
retrieval_method: APIRetrievalMethod | Omit = omit,
tags: SequenceNotStr[str] | Omit = omit,
temperature: float | Omit = omit,
top_p: float | Omit = omit,
body_uuid: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AgentUpdateResponse:
"""To update an agent, send a PUT request to `/v2/gen-ai/agents/{uuid}`.
The
response body is a JSON object containing the agent.
Args:
allowed_domains: Optional list of allowed domains for the chatbot - Must use fully qualified
domain name (FQDN) such as https://example.com
anthropic_key_uuid: Optional anthropic key uuid for use with anthropic models
conversation_logs_enabled: Optional update of conversation logs enabled
description: Agent description
instruction: Agent instruction. Instructions help your agent to perform its job effectively.
See
[Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
for best practices.
k: How many results should be considered from an attached knowledge base
max_tokens: Specifies the maximum number of tokens the model can process in a single input
or output, set as a number between 1 and 512. This determines the length of each
response.
model_provider_key_uuid: Optional Model Provider uuid for use with provider models
model_uuid: Identifier for the foundation model.
name: Agent name
openai_key_uuid: Optional OpenAI key uuid for use with OpenAI models
project_id: The id of the DigitalOcean project this agent will belong to
retrieval_method: - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown
- RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite
- RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back
- RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries
- RETRIEVAL_METHOD_NONE: The retrieval method is none
tags: A set of abitrary tags to organize your agent
temperature: Controls the model’s creativity, specified as a number between 0 and 1. Lower
values produce more predictable and conservative responses, while higher values
encourage creativity and variation.
top_p: Defines the cumulative probability threshold for word selection, specified as a
number between 0 and 1. Higher values allow for more diverse outputs, while
lower values ensure focused and coherent responses.
body_uuid: Unique agent id
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
if not path_uuid:
raise ValueError(f"Expected a non-empty value for `path_uuid` but received {path_uuid!r}")
return await self._put(
f"/v2/gen-ai/agents/{path_uuid}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/gen-ai/agents/{path_uuid}",