Skip to main content

annotation_queues

Creates, updates, deletes, gets or lists an annotation_queues resource.

Overview

Nameannotation_queues
TypeResource
Iddatadog.llm_observability.annotation_queues

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringUnique identifier of the annotation queue. (example: 00000000-0000-0000-0000-000000000001)
attributesobjectAttributes of an Agent Observability annotation queue.
typestringResource type of an Agent Observability annotation queue. (queues) (example: queues)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_llmobs_annotation_queuesselectproject_id, queue_idsList annotation queues. Optionally filter by project ID or queue IDs. These parameters are mutually exclusive.<br />If neither is provided, all queues in the organization are returned.
create_llmobs_annotation_queueinsertdataCreate an annotation queue. The name and project_id fields are required.<br />An optional annotation_schema can be provided to define the labels for the queue.<br />Fields such as created_by, owned_by, created_at, modified_by,<br />and modified_at are inferred by the backend.
update_llmobs_annotation_queueupdatequeue_id, dataPartially update an annotation queue. The name, description, and annotation_schema fields can be updated.
delete_llmobs_annotation_queuedeletequeue_idDelete an annotation queue by its ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
queue_idstringThe ID of the Agent Observability annotation queue. (example: 00000000-0000-0000-0000-000000000001)
sitestringThe Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
project_idstringFilter annotation queues by project ID. Cannot be used together with queueIds. (wire: projectId)
queue_idsarrayFilter annotation queues by queue IDs (comma-separated). Cannot be used together with projectId. (wire: queueIds)

SELECT examples

List annotation queues. Optionally filter by project ID or queue IDs. These parameters are mutually exclusive.<br />If neither is provided, all queues in the organization are returned.

SELECT
id,
attributes,
type
FROM datadog.llm_observability.annotation_queues
WHERE project_id = '{{ project_id }}'
AND queue_ids = '{{ queue_ids }}'
;

INSERT examples

Create an annotation queue. The name and project_id fields are required.<br />An optional annotation_schema can be provided to define the labels for the queue.<br />Fields such as created_by, owned_by, created_at, modified_by,<br />and modified_at are inferred by the backend.

INSERT INTO datadog.llm_observability.annotation_queues (
data
)
SELECT
'{{ data }}' /* required */
RETURNING
data
;

UPDATE examples

Partially update an annotation queue. The name, description, and annotation_schema fields can be updated.

UPDATE datadog.llm_observability.annotation_queues
SET
data = '{{ data }}'
WHERE
queue_id = '{{ queue_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

Delete an annotation queue by its ID.

DELETE FROM datadog.llm_observability.annotation_queues
WHERE queue_id = '{{ queue_id }}' --required
;