Skip to main content

annotation_queue_label_schemas

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

Overview

Nameannotation_queue_label_schemas
TypeResource
Iddatadog.llm_observability.annotation_queue_label_schemas

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 annotation queue label schema.
typestringResource type of an Agent Observability annotation queue. (queues) (example: queues)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_llmobs_annotation_queue_label_schemaselectqueue_idRetrieve the label schema for a given annotation queue.
update_llmobs_annotation_queue_label_schemareplacequeue_id, dataCreate or replace the label schema for a given annotation queue.<br />The label schema defines the labels annotators can apply to interactions in the queue.<br />Label names must be unique within the queue and match the pattern ^&#91;a-zA-Z0-9_-&#93;+$.<br />Each label must have a valid type: score, categorical, boolean, or text.

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.

SELECT examples

Retrieve the label schema for a given annotation queue.

SELECT
id,
attributes,
type
FROM datadog.llm_observability.annotation_queue_label_schemas
WHERE queue_id = '{{ queue_id }}' -- required
;

REPLACE examples

Create or replace the label schema for a given annotation queue.<br />The label schema defines the labels annotators can apply to interactions in the queue.<br />Label names must be unique within the queue and match the pattern ^&#91;a-zA-Z0-9_-&#93;+$.<br />Each label must have a valid type: score, categorical, boolean, or text.

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