Response containing a single annotated interaction and its related events.
Expand All
Field
Type
Description
data [required]
object
Data object for a single annotated interaction.
attributes [required]
object
Attributes containing an annotated interaction and its related events.
annotated_interaction [required]
<oneOf>
An interaction with its associated annotations.
Object 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.
can_annotate [required]
boolean
Whether the current caller can annotate this interaction.
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
<type=display_block>
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.
can_annotate [required]
boolean
Whether the current caller can annotate this interaction.
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.
code
string
HTML code rendered by a frontend block. Required for frontend blocks.
content
Block payload. A string for markdown, header, and text; an
arbitrary JSON value (object, array, or scalar) for json. Omitted
for image, widget, llmobs_trace, and frontend.
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 a frontend 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,frontend
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
events [required]
[object]
Page of events associated with the annotated interaction.
attributes [required]
object
Attributes of an event associated with an annotated interaction.
id [required]
string
Unique identifier of the event.
type [required]
string
Type of the event.
interaction_type [required]
enum
Type of an annotated interaction.
Allowed enum values: trace,experiment_trace,session,display_block
next_cursor
string
Cursor to retrieve the next page of events. Absent when there are no more events.
id [required]
string
Unique identifier of the interaction.
type [required]
enum
Resource type for annotated interactions.
Allowed enum values: annotated_interactions
# Path parameters exportqueue_id="00000000-0000-0000-0000-000000000001" exportinteraction_id="interaction-456" # Use a Personal Access Token or Service Access Token exportDD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
"""
Get an annotated queue interaction returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.agent_observability_apiimportAgentObservabilityApiconfiguration=Configuration()configuration.access_token=environ["DD_BEARER_TOKEN"]configuration.unstable_operations["get_llm_obs_annotated_interaction"]=TruewithApiClient(configuration)asapi_client:api_instance=AgentObservabilityApi(api_client)response=api_instance.get_llm_obs_annotated_interaction(queue_id="queue_id",interaction_id="interaction_id",)print(response)
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"python3"example.py"
# Get an annotated queue interaction returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.access_token=ENV["DD_BEARER_TOKEN"]config.unstable_operations["v2.get_llm_obs_annotated_interaction".to_sym]=trueendapi_instance=DatadogAPIClient::V2::AgentObservabilityAPI.newpapi_instance.get_llm_obs_annotated_interaction("queue_id","interaction_id")
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"rb"example.rb"
// Get an annotated queue interaction returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())ctx=context.WithValue(ctx,datadog.ContextAccessToken,os.Getenv("DD_BEARER_TOKEN"))configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetLLMObsAnnotatedInteraction",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewAgentObservabilityApi(apiClient)resp,r,err:=api.GetLLMObsAnnotatedInteraction(ctx,"queue_id","interaction_id",*datadogV2.NewGetLLMObsAnnotatedInteractionOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `AgentObservabilityApi.GetLLMObsAnnotatedInteraction`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `AgentObservabilityApi.GetLLMObsAnnotatedInteraction`:\n%s\n",responseContent)}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"go run"main.go"
// Get an annotated queue interaction returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.AgentObservabilityApi;importcom.datadog.api.client.v2.model.LLMObsAnnotatedInteractionResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));defaultClient.setUnstableOperationEnabled("v2.getLLMObsAnnotatedInteraction",true);AgentObservabilityApiapiInstance=newAgentObservabilityApi(defaultClient);try{LLMObsAnnotatedInteractionResponseresult=apiInstance.getLLMObsAnnotatedInteraction("00000000-0000-0000-0000-000000000001","interaction-456");System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling AgentObservabilityApi#getLLMObsAnnotatedInteraction");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"java"Example.java"
// Get an annotated queue interaction returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_agent_observability::AgentObservabilityAPI;usedatadog_api_client::datadogV2::api_agent_observability::GetLLMObsAnnotatedInteractionOptionalParams;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetLLMObsAnnotatedInteraction",true);letapi=AgentObservabilityAPI::with_config(configuration);letresp=api.get_llm_obs_annotated_interaction("queue_id".to_string(),"interaction_id".to_string(),GetLLMObsAnnotatedInteractionOptionalParams::default(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get an annotated queue interaction returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration({authMethods:{AuthZ:{accessToken: process.env.DD_BEARER_TOKENasstring,},},});configuration.unstableOperations["v2.getLLMObsAnnotatedInteraction"]=true;constapiInstance=newv2.AgentObservabilityApi(configuration);constparams: v2.AgentObservabilityApiGetLLMObsAnnotatedInteractionRequest={queueId:"queue_id",interactionId:"interaction_id",};apiInstance.getLLMObsAnnotatedInteraction(params).then((data: v2.LLMObsAnnotatedInteractionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"tsc"example.ts"
Request a personalized demo
Get Started with Datadog
Ask AI
AI-generated responses may be inaccurate. Verify important info.