Response containing the annotated interactions for an annotation queue.
Expand All
Field
Type
Description
data [required]
object
Data object for annotated interactions.
attributes [required]
object
Attributes containing the list of annotated interactions.
annotated_interactions [required]
[ <oneOf>]
List of interactions with their annotations.
Option 1
object
A trace, experiment trace, or session interaction with its associated annotations.
annotations [required]
[object]
List of annotations for this interaction.
created_at [required]
date-time
Timestamp when the annotation was created.
created_by [required]
string
Identifier of the user who created the annotation.
id [required]
string
Unique identifier of the annotation.
interaction_id [required]
string
Identifier of the interaction this annotation belongs to.
label_values [required]
object
Label values for this annotation.
modified_at [required]
date-time
Timestamp when the annotation was last modified.
modified_by [required]
string
Identifier of the user who last modified the annotation.
content_id [required]
string
Upstream entity identifier supplied by the caller.
created_at [required]
date-time
Timestamp when the interaction was added to the queue.
id [required]
string
Unique identifier of the interaction.
modified_at [required]
date-time
Timestamp when the interaction was last updated.
type [required]
enum
Type of an upstream-entity interaction.
Allowed enum values: trace,experiment_trace,session
Option 2
object
A display_block interaction with its associated annotations.
annotations [required]
[object]
List of annotations for this interaction.
created_at [required]
date-time
Timestamp when the annotation was created.
created_by [required]
string
Identifier of the user who created the annotation.
id [required]
string
Unique identifier of the annotation.
interaction_id [required]
string
Identifier of the interaction this annotation belongs to.
label_values [required]
object
Label values for this annotation.
modified_at [required]
date-time
Timestamp when the annotation was last modified.
modified_by [required]
string
Identifier of the user who last modified the annotation.
content_id [required]
string
Server-generated deterministic identifier derived from the block list.
display_block [required]
[object]
List of content blocks that make up a display_block interaction.
Must contain at least one block.
alt
string
Alternative text for an image block.
content
Block payload. A string for markdown, header, and text; an
arbitrary JSON value (object, array, or scalar) for json. Omitted
for image, widget, and llmobs_trace.
height
int64
Optional rendered height. Must be positive when set.
interactionType
enum
Upstream interaction type referenced by an llmobs_trace block.
Restricted to trace or experiment_trace.
Allowed enum values: trace,experiment_trace
label
string
Optional label rendered alongside the block.
level
enum
Visual size for a header block.
Allowed enum values: sm,md,lg,xl
tileDef
Tile definition for a widget block. Required for widget. The
schema is owned by the frontend renderer.
timeFrame
object
Unix-millis time range used by chart blocks.
end [required]
int64
End of the range, in Unix milliseconds.
start [required]
int64
Start of the range, in Unix milliseconds.
traceId
string
Trace identifier. Required for llmobs_trace blocks.
type [required]
enum
Discriminator for a single display_block content block. Adding a
variant requires coordinated changes in the frontend renderer.
Allowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
string
URL of the image. Required for image blocks.
id [required]
string
Unique identifier of the interaction.
type [required]
enum
Type discriminator for a display_block interaction.
Allowed enum values: display_block
id [required]
string
The annotation queue ID.
type [required]
enum
Resource type for annotated interactions.
Allowed enum values: annotated_interactions
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get annotated queue interactions returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getLLMObsAnnotatedInteractions"]=true;constapiInstance=newv2.LLMObservabilityApi(configuration);constparams: v2.LLMObservabilityApiGetLLMObsAnnotatedInteractionsRequest={queueId:"queue_id",};apiInstance.getLLMObsAnnotatedInteractions(params).then((data: v2.LLMObsAnnotatedInteractionsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
