annotation_queue_annotations

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

Overview

Name	annotation_queue_annotations
Type	Resource
Id	datadog.llm_observability.annotation_queue_annotations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
upsert_llmobs_annotations	insert	queue_id, data		Create or update annotations on interactions in a queue. Each annotation is matched<br />by interaction_id and the requesting user's identity.<br />Results and errors in the response are linked to request items by interaction_id.<br />Errors for individual items are returned in the errors field without blocking the rest of the batch.
delete_llmobs_annotations	exec	queue_id, data		Delete one or more annotations from an annotation queue.

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.

Name	Datatype	Description
queue_id	string	The ID of the Agent Observability annotation queue. (example: 00000000-0000-0000-0000-000000000001)
site	string	The 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.

INSERT examples

upsert_llmobs_annotations

Create or update annotations on interactions in a queue. Each annotation is matched<br />by interaction_id and the requesting user's identity.<br />Results and errors in the response are linked to request items by interaction_id.<br />Errors for individual items are returned in the errors field without blocking the rest of the batch.

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

Manifest

# Description fields are for documentation purposes
- name: annotation_queue_annotations
props:
  - name: queue_id
    value: "{{ queue_id }}"
    description: Required parameter for the annotation_queue_annotations resource.
  - name: data
    description: |
      Data object for creating or updating annotations.
    value:
      attributes:
        annotations:
          - interaction_id: "{{ interaction_id }}"
            label_values: "{{ label_values }}"
      type: "{{ type }}"

Lifecycle Methods

EXEC variables use wire (API) names.

delete_llmobs_annotations

Delete one or more annotations from an annotation queue.

EXEC datadog.llm_observability.annotation_queue_annotations.delete_llmobs_annotations 
@queue_id='{{ queue_id }}' --required, 
@@json=
'{
"data": "{{ data }}"
}'
;