Skip to content

Commit bd26647

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Annotations endpoints (#3393)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent c0ea779 commit bd26647

File tree

44 files changed

+3349
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+3349
-5
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 786 additions & 1 deletion
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16230,6 +16230,188 @@ datadog\_api\_client.v2.model.list\_vulnerable\_assets\_response module
1623016230
:members:
1623116231
:show-inheritance:
1623216232

16233+
datadog\_api\_client.v2.model.llm\_obs\_annotated\_interaction\_item module
16234+
---------------------------------------------------------------------------
16235+
16236+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotated_interaction_item
16237+
:members:
16238+
:show-inheritance:
16239+
16240+
datadog\_api\_client.v2.model.llm\_obs\_annotated\_interactions\_data\_attributes\_response module
16241+
--------------------------------------------------------------------------------------------------
16242+
16243+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotated_interactions_data_attributes_response
16244+
:members:
16245+
:show-inheritance:
16246+
16247+
datadog\_api\_client.v2.model.llm\_obs\_annotated\_interactions\_data\_response module
16248+
--------------------------------------------------------------------------------------
16249+
16250+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotated_interactions_data_response
16251+
:members:
16252+
:show-inheritance:
16253+
16254+
datadog\_api\_client.v2.model.llm\_obs\_annotated\_interactions\_response module
16255+
--------------------------------------------------------------------------------
16256+
16257+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotated_interactions_response
16258+
:members:
16259+
:show-inheritance:
16260+
16261+
datadog\_api\_client.v2.model.llm\_obs\_annotated\_interactions\_type module
16262+
----------------------------------------------------------------------------
16263+
16264+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotated_interactions_type
16265+
:members:
16266+
:show-inheritance:
16267+
16268+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_item module
16269+
---------------------------------------------------------------
16270+
16271+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_item
16272+
:members:
16273+
:show-inheritance:
16274+
16275+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_data\_attributes\_request module
16276+
-------------------------------------------------------------------------------------------
16277+
16278+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_data_attributes_request
16279+
:members:
16280+
:show-inheritance:
16281+
16282+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_data\_attributes\_response module
16283+
--------------------------------------------------------------------------------------------
16284+
16285+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_data_attributes_response
16286+
:members:
16287+
:show-inheritance:
16288+
16289+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_data\_request module
16290+
-------------------------------------------------------------------------------
16291+
16292+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_data_request
16293+
:members:
16294+
:show-inheritance:
16295+
16296+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_data\_response module
16297+
--------------------------------------------------------------------------------
16298+
16299+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_data_response
16300+
:members:
16301+
:show-inheritance:
16302+
16303+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interaction\_item module
16304+
-----------------------------------------------------------------------------------
16305+
16306+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interaction_item
16307+
:members:
16308+
:show-inheritance:
16309+
16310+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interaction\_response\_item module
16311+
---------------------------------------------------------------------------------------------
16312+
16313+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interaction_response_item
16314+
:members:
16315+
:show-inheritance:
16316+
16317+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_data\_attributes\_request module
16318+
---------------------------------------------------------------------------------------------------------
16319+
16320+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_attributes_request
16321+
:members:
16322+
:show-inheritance:
16323+
16324+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_data\_attributes\_response module
16325+
----------------------------------------------------------------------------------------------------------
16326+
16327+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_attributes_response
16328+
:members:
16329+
:show-inheritance:
16330+
16331+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_data\_request module
16332+
---------------------------------------------------------------------------------------------
16333+
16334+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_request
16335+
:members:
16336+
:show-inheritance:
16337+
16338+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_data\_response module
16339+
----------------------------------------------------------------------------------------------
16340+
16341+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_response
16342+
:members:
16343+
:show-inheritance:
16344+
16345+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_request module
16346+
---------------------------------------------------------------------------------------
16347+
16348+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_request
16349+
:members:
16350+
:show-inheritance:
16351+
16352+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_response module
16353+
----------------------------------------------------------------------------------------
16354+
16355+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_response
16356+
:members:
16357+
:show-inheritance:
16358+
16359+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_type module
16360+
------------------------------------------------------------------------------------
16361+
16362+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_type
16363+
:members:
16364+
:show-inheritance:
16365+
16366+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_request module
16367+
-------------------------------------------------------------------------
16368+
16369+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_request
16370+
:members:
16371+
:show-inheritance:
16372+
16373+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_response module
16374+
--------------------------------------------------------------------------
16375+
16376+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_response
16377+
:members:
16378+
:show-inheritance:
16379+
16380+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_type module
16381+
----------------------------------------------------------------------
16382+
16383+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_type
16384+
:members:
16385+
:show-inheritance:
16386+
16387+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_update\_data\_attributes\_request module
16388+
---------------------------------------------------------------------------------------------------
16389+
16390+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_update_data_attributes_request
16391+
:members:
16392+
:show-inheritance:
16393+
16394+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_update\_data\_request module
16395+
---------------------------------------------------------------------------------------
16396+
16397+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_update_data_request
16398+
:members:
16399+
:show-inheritance:
16400+
16401+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_update\_request module
16402+
---------------------------------------------------------------------------------
16403+
16404+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_update_request
16405+
:members:
16406+
:show-inheritance:
16407+
16408+
datadog\_api\_client.v2.model.llm\_obs\_annotation\_queues\_response module
16409+
---------------------------------------------------------------------------
16410+
16411+
.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queues_response
16412+
:members:
16413+
:show-inheritance:
16414+
1623316415
datadog\_api\_client.v2.model.llm\_obs\_cursor\_meta module
1623416416
-----------------------------------------------------------
1623516417

@@ -16398,6 +16580,27 @@ datadog\_api\_client.v2.model.llm\_obs\_datasets\_response module
1639816580
:members:
1639916581
:show-inheritance:
1640016582

16583+
datadog\_api\_client.v2.model.llm\_obs\_delete\_annotation\_queue\_interactions\_data\_attributes\_request module
16584+
-----------------------------------------------------------------------------------------------------------------
16585+
16586+
.. automodule:: datadog_api_client.v2.model.llm_obs_delete_annotation_queue_interactions_data_attributes_request
16587+
:members:
16588+
:show-inheritance:
16589+
16590+
datadog\_api\_client.v2.model.llm\_obs\_delete\_annotation\_queue\_interactions\_data\_request module
16591+
-----------------------------------------------------------------------------------------------------
16592+
16593+
.. automodule:: datadog_api_client.v2.model.llm_obs_delete_annotation_queue_interactions_data_request
16594+
:members:
16595+
:show-inheritance:
16596+
16597+
datadog\_api\_client.v2.model.llm\_obs\_delete\_annotation\_queue\_interactions\_request module
16598+
-----------------------------------------------------------------------------------------------
16599+
16600+
.. automodule:: datadog_api_client.v2.model.llm_obs_delete_annotation_queue_interactions_request
16601+
:members:
16602+
:show-inheritance:
16603+
1640116604
datadog\_api\_client.v2.model.llm\_obs\_delete\_dataset\_records\_data\_attributes\_request module
1640216605
--------------------------------------------------------------------------------------------------
1640316606

@@ -16629,6 +16832,13 @@ datadog\_api\_client.v2.model.llm\_obs\_experiments\_response module
1662916832
:members:
1663016833
:show-inheritance:
1663116834

16835+
datadog\_api\_client.v2.model.llm\_obs\_interaction\_type module
16836+
----------------------------------------------------------------
16837+
16838+
.. automodule:: datadog_api_client.v2.model.llm_obs_interaction_type
16839+
:members:
16840+
:show-inheritance:
16841+
1663216842
datadog\_api\_client.v2.model.llm\_obs\_metric\_assessment module
1663316843
-----------------------------------------------------------------
1663416844

‎examples/v2/llm-observability/CreateLLMObsAnnotationQueue.py‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
"""
2+
Create an LLM Observability annotation queue returns "Created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
7+
from datadog_api_client.v2.model.llm_obs_annotation_queue_data_attributes_request import (
8+
LLMObsAnnotationQueueDataAttributesRequest,
9+
)
10+
from datadog_api_client.v2.model.llm_obs_annotation_queue_data_request import LLMObsAnnotationQueueDataRequest
11+
from datadog_api_client.v2.model.llm_obs_annotation_queue_request import LLMObsAnnotationQueueRequest
12+
from datadog_api_client.v2.model.llm_obs_annotation_queue_type import LLMObsAnnotationQueueType
13+
14+
body = LLMObsAnnotationQueueRequest(
15+
data=LLMObsAnnotationQueueDataRequest(
16+
attributes=LLMObsAnnotationQueueDataAttributesRequest(
17+
description="Queue for annotating customer support traces",
18+
name="My annotation queue",
19+
project_id="a33671aa-24fd-4dcd-9b33-a8ec7dde7751",
20+
),
21+
type=LLMObsAnnotationQueueType.QUEUES,
22+
),
23+
)
24+
25+
configuration = Configuration()
26+
configuration.unstable_operations["create_llm_obs_annotation_queue"] = True
27+
with ApiClient(configuration) as api_client:
28+
api_instance = LLMObservabilityApi(api_client)
29+
response = api_instance.create_llm_obs_annotation_queue(body=body)
30+
31+
print(response)

‎examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.py‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
"""
2+
Add annotation queue interactions returns "Created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
7+
from datadog_api_client.v2.model.llm_obs_annotation_queue_interaction_item import LLMObsAnnotationQueueInteractionItem
8+
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_attributes_request import (
9+
LLMObsAnnotationQueueInteractionsDataAttributesRequest,
10+
)
11+
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_request import (
12+
LLMObsAnnotationQueueInteractionsDataRequest,
13+
)
14+
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_request import (
15+
LLMObsAnnotationQueueInteractionsRequest,
16+
)
17+
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_type import LLMObsAnnotationQueueInteractionsType
18+
from datadog_api_client.v2.model.llm_obs_interaction_type import LLMObsInteractionType
19+
20+
body = LLMObsAnnotationQueueInteractionsRequest(
21+
data=LLMObsAnnotationQueueInteractionsDataRequest(
22+
attributes=LLMObsAnnotationQueueInteractionsDataAttributesRequest(
23+
interactions=[
24+
LLMObsAnnotationQueueInteractionItem(
25+
content_id="trace-abc-123",
26+
type=LLMObsInteractionType.TRACE,
27+
),
28+
],
29+
),
30+
type=LLMObsAnnotationQueueInteractionsType.INTERACTIONS,
31+
),
32+
)
33+
34+
configuration = Configuration()
35+
configuration.unstable_operations["create_llm_obs_annotation_queue_interactions"] = True
36+
with ApiClient(configuration) as api_client:
37+
api_instance = LLMObservabilityApi(api_client)
38+
response = api_instance.create_llm_obs_annotation_queue_interactions(queue_id="queue_id", body=body)
39+
40+
print(response)

‎examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Delete an LLM Observability annotation queue returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["delete_llm_obs_annotation_queue"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = LLMObservabilityApi(api_client)
12+
api_instance.delete_llm_obs_annotation_queue(
13+
queue_id="queue_id",
14+
)

‎examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.py‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
"""
2+
Delete annotation queue interactions returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
7+
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_type import LLMObsAnnotationQueueInteractionsType
8+
from datadog_api_client.v2.model.llm_obs_delete_annotation_queue_interactions_data_attributes_request import (
9+
LLMObsDeleteAnnotationQueueInteractionsDataAttributesRequest,
10+
)
11+
from datadog_api_client.v2.model.llm_obs_delete_annotation_queue_interactions_data_request import (
12+
LLMObsDeleteAnnotationQueueInteractionsDataRequest,
13+
)
14+
from datadog_api_client.v2.model.llm_obs_delete_annotation_queue_interactions_request import (
15+
LLMObsDeleteAnnotationQueueInteractionsRequest,
16+
)
17+
18+
body = LLMObsDeleteAnnotationQueueInteractionsRequest(
19+
data=LLMObsDeleteAnnotationQueueInteractionsDataRequest(
20+
attributes=LLMObsDeleteAnnotationQueueInteractionsDataAttributesRequest(
21+
interaction_ids=[
22+
"00000000-0000-0000-0000-000000000000",
23+
"00000000-0000-0000-0000-000000000001",
24+
],
25+
),
26+
type=LLMObsAnnotationQueueInteractionsType.INTERACTIONS,
27+
),
28+
)
29+
30+
configuration = Configuration()
31+
configuration.unstable_operations["delete_llm_obs_annotation_queue_interactions"] = True
32+
with ApiClient(configuration) as api_client:
33+
api_instance = LLMObservabilityApi(api_client)
34+
api_instance.delete_llm_obs_annotation_queue_interactions(queue_id="queue_id", body=body)

‎examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Get annotated queue interactions returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_llm_obs_annotated_interactions"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = LLMObservabilityApi(api_client)
12+
response = api_instance.get_llm_obs_annotated_interactions(
13+
queue_id="queue_id",
14+
)
15+
16+
print(response)

‎examples/v2/llm-observability/ListLLMObsAnnotationQueues.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
List LLM Observability annotation queues returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_llm_obs_annotation_queues"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = LLMObservabilityApi(api_client)
12+
response = api_instance.list_llm_obs_annotation_queues()
13+
14+
print(response)

0 commit comments

Comments
 (0)