Skip to content

Document Annotations label schema API for AI Observability #3458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
api-clients-generation-pipeline merged 1 commit into from
Apr 29, 2026
Merged

Document Annotations label schema API for AI Observability #3458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
381 changes: 378 additions & 3 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

63 changes: 63 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16916,6 +16916,48 @@ datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_interactions\_type mo
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_label\_schema\_attributes module
-------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_label\_schema\_data module
-------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_label\_schema\_response module
-----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_label\_schema\_update\_attributes module
---------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_update_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_label\_schema\_update\_data module
---------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_update_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_label\_schema\_update\_request module
------------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_update_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_queue\_request module
-------------------------------------------------------------------------

Expand Down Expand Up @@ -16965,6 +17007,13 @@ datadog\_api\_client.v2.model.llm\_obs\_annotation\_queues\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_annotation\_schema module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_annotation_schema
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_cursor\_meta module
-----------------------------------------------------------

Expand Down Expand Up @@ -17553,6 +17602,20 @@ datadog\_api\_client.v2.model.llm\_obs\_interaction\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_label\_schema module
------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_label_schema
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_label\_schema\_type module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.llm_obs_label_schema_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.llm\_obs\_metric\_assessment module
-----------------------------------------------------------------

Expand Down
25 changes: 25 additions & 0 deletions examples/v2/llm-observability/CreateLLMObsAnnotationQueue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,35 @@
from datadog_api_client.v2.model.llm_obs_annotation_queue_data_request import LLMObsAnnotationQueueDataRequest
from datadog_api_client.v2.model.llm_obs_annotation_queue_request import LLMObsAnnotationQueueRequest
from datadog_api_client.v2.model.llm_obs_annotation_queue_type import LLMObsAnnotationQueueType
from datadog_api_client.v2.model.llm_obs_annotation_schema import LLMObsAnnotationSchema
from datadog_api_client.v2.model.llm_obs_label_schema import LLMObsLabelSchema
from datadog_api_client.v2.model.llm_obs_label_schema_type import LLMObsLabelSchemaType

body = LLMObsAnnotationQueueRequest(
data=LLMObsAnnotationQueueDataRequest(
attributes=LLMObsAnnotationQueueDataAttributesRequest(
annotation_schema=LLMObsAnnotationSchema(
label_schemas=[
LLMObsLabelSchema(
description="Rating of the response quality.",
has_assessment=False,
has_reasoning=False,
id="ab12cd34",
is_assessment=False,
is_integer=False,
is_required=True,
max=5.0,
min=0.0,
name="quality",
type=LLMObsLabelSchemaType.SCORE,
values=[
"good",
"bad",
"neutral",
],
),
],
),
description="Queue for annotating customer support traces",
name="My annotation queue",
project_id="a33671aa-24fd-4dcd-9b33-a8ec7dde7751",
Expand Down
16 changes: 16 additions & 0 deletions examples/v2/llm-observability/GetLLMObsAnnotationQueueLabelSchema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get annotation queue label schema returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi

configuration = Configuration()
configuration.unstable_operations["get_llm_obs_annotation_queue_label_schema"] = True
with ApiClient(configuration) as api_client:
api_instance = LLMObservabilityApi(api_client)
response = api_instance.get_llm_obs_annotation_queue_label_schema(
queue_id="queue_id",
)

print(response)
25 changes: 25 additions & 0 deletions examples/v2/llm-observability/UpdateLLMObsAnnotationQueue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,35 @@
LLMObsAnnotationQueueUpdateDataRequest,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_update_request import LLMObsAnnotationQueueUpdateRequest
from datadog_api_client.v2.model.llm_obs_annotation_schema import LLMObsAnnotationSchema
from datadog_api_client.v2.model.llm_obs_label_schema import LLMObsLabelSchema
from datadog_api_client.v2.model.llm_obs_label_schema_type import LLMObsLabelSchemaType

body = LLMObsAnnotationQueueUpdateRequest(
data=LLMObsAnnotationQueueUpdateDataRequest(
attributes=LLMObsAnnotationQueueUpdateDataAttributesRequest(
annotation_schema=LLMObsAnnotationSchema(
label_schemas=[
LLMObsLabelSchema(
description="Rating of the response quality.",
has_assessment=False,
has_reasoning=False,
id="ab12cd34",
is_assessment=False,
is_integer=False,
is_required=True,
max=5.0,
min=0.0,
name="quality",
type=LLMObsLabelSchemaType.SCORE,
values=[
"good",
"bad",
"neutral",
],
),
],
),
description="Updated description",
name="Updated queue name",
),
Expand Down
57 changes: 57 additions & 0 deletions examples/v2/llm-observability/UpdateLLMObsAnnotationQueueLabelSchema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
"""
Update annotation queue label schema returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
from datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_update_attributes import (
LLMObsAnnotationQueueLabelSchemaUpdateAttributes,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_update_data import (
LLMObsAnnotationQueueLabelSchemaUpdateData,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_label_schema_update_request import (
LLMObsAnnotationQueueLabelSchemaUpdateRequest,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_type import LLMObsAnnotationQueueType
from datadog_api_client.v2.model.llm_obs_annotation_schema import LLMObsAnnotationSchema
from datadog_api_client.v2.model.llm_obs_label_schema import LLMObsLabelSchema
from datadog_api_client.v2.model.llm_obs_label_schema_type import LLMObsLabelSchemaType

body = LLMObsAnnotationQueueLabelSchemaUpdateRequest(
data=LLMObsAnnotationQueueLabelSchemaUpdateData(
attributes=LLMObsAnnotationQueueLabelSchemaUpdateAttributes(
annotation_schema=LLMObsAnnotationSchema(
label_schemas=[
LLMObsLabelSchema(
description="Rating of the response quality.",
has_assessment=False,
has_reasoning=False,
id="ab12cd34",
is_assessment=False,
is_integer=False,
is_required=True,
max=5.0,
min=0.0,
name="quality",
type=LLMObsLabelSchemaType.SCORE,
values=[
"good",
"bad",
"neutral",
],
),
],
),
),
type=LLMObsAnnotationQueueType.QUEUES,
),
)

configuration = Configuration()
configuration.unstable_operations["update_llm_obs_annotation_queue_label_schema"] = True
with ApiClient(configuration) as api_client:
api_instance = LLMObservabilityApi(api_client)
response = api_instance.update_llm_obs_annotation_queue_label_schema(queue_id="queue_id", body=body)

print(response)
2 changes: 2 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,13 +280,15 @@ def __init__(
"v2.delete_llm_obs_experiments": False,
"v2.delete_llm_obs_projects": False,
"v2.get_llm_obs_annotated_interactions": False,
"v2.get_llm_obs_annotation_queue_label_schema": False,
"v2.get_llm_obs_custom_eval_config": False,
"v2.list_llm_obs_annotation_queues": False,
"v2.list_llm_obs_dataset_records": False,
"v2.list_llm_obs_datasets": False,
"v2.list_llm_obs_experiments": False,
"v2.list_llm_obs_projects": False,
"v2.update_llm_obs_annotation_queue": False,
"v2.update_llm_obs_annotation_queue_label_schema": False,
"v2.update_llm_obs_custom_eval_config": False,
"v2.update_llm_obs_dataset": False,
"v2.update_llm_obs_dataset_records": False,
Expand Down
Loading
Loading