Add annotation queue interactions
警告Note: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST
https://api.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.us3.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.us5.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.datadoghq.eu/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.ap1.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.ap2.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.uk1.datadoghq.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactionshttps://api.us2.ddog-gov.com/api/v2/llm-obs/v1/annotation-queues/{queue_id}/interactions概要
Add one or more interactions to an annotation queue. At least one
interaction must be provided. Each interaction has a type:
trace,experiment_trace,session:content_idreferences the upstream entity; the server fetches the actual content.display_block: omitcontent_idand provide the rendered content indisplay_block. The server generatescontent_idas a deterministic hash of the block list.
Items of different types can be mixed in a single request.
引数
パスパラメーター
名前
タイプ
説明
queue_id [required]string
The ID of the Agent Observability annotation queue.
リクエスト
Body Data (required)
Add interactions payload.
フィールド
タイプ
説明
data [required]object
Data object for adding interactions to an annotation queue.
attributes [required]object
Attributes for adding interactions to an annotation queue.
interactions [required][<oneOf>]
List of interactions to add to the queue. Must contain at least one item.
Object 1object
An interaction that references an upstream trace, experiment trace, or session.
content_id [required]string
Upstream entity identifier (trace, experiment trace, or session ID).
type [required]enum
Type of an upstream-entity interaction.
Allowed enum values:
trace, experiment_trace, session<type=display_block>object
An interaction whose rendered content is supplied directly as a list
of display blocks. The server generates content_id deterministically
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.
altstring
Alternative text for an image block.
codestring
HTML code rendered by a frontend block. Required for frontend blocks.
contentany
Block payload. A string for markdown, header, and text; an
arbitrary JSON value (object, array, or scalar) for json. Omitted
for image, univiz, llmobs_trace, and frontend.
heightint64
Optional rendered height. Must be positive when set.
interactionTypeenum
Upstream interaction type referenced by an llmobs_trace block.
Restricted to trace or experiment_trace.
Allowed enum values:
trace, experiment_tracelabelstring
Optional label rendered alongside a frontend block.
levelenum
Visual size for a header block.
Allowed enum values:
sm, md, lg, xltileDefany
Tile definition for a univiz block. Required for univiz. The
schema is owned by the frontend renderer.
timeFrameobject
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.
traceIdstring
Trace identifier. Required for llmobs_trace blocks.
typeenum
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, univiz, llmobs_trace, frontendurlstring
URL of the image. Required for image blocks.
type [required]enum
Type discriminator for a display_block interaction.
Allowed enum values:
display_blocktype [required]enum
Resource type for annotation queue interactions.
Allowed enum values:
interactions{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}応答
Created
Response containing the result of adding interactions to an annotation queue.
フィールド
タイプ
説明
data [required]object
Data object for the interaction addition response.
attributes [required]object
Attributes of the interaction addition response.
interactions [required][<oneOf>]
List of interactions that were processed.
Object 1object
A trace, experiment trace, or session interaction result.
already_existed [required]boolean
Whether this interaction already existed in the queue.
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 result.
already_existed [required]boolean
Whether this interaction already existed in the queue.
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.
altstring
Alternative text for an image block.
codestring
HTML code rendered by a frontend block. Required for frontend blocks.
contentany
Block payload. A string for markdown, header, and text; an
arbitrary JSON value (object, array, or scalar) for json. Omitted
for image, univiz, llmobs_trace, and frontend.
heightint64
Optional rendered height. Must be positive when set.
interactionTypeenum
Upstream interaction type referenced by an llmobs_trace block.
Restricted to trace or experiment_trace.
Allowed enum values:
trace, experiment_tracelabelstring
Optional label rendered alongside a frontend block.
levelenum
Visual size for a header block.
Allowed enum values:
sm, md, lg, xltileDefany
Tile definition for a univiz block. Required for univiz. The
schema is owned by the frontend renderer.
timeFrameobject
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.
traceIdstring
Trace identifier. Required for llmobs_trace blocks.
typeenum
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, univiz, llmobs_trace, frontendurlstring
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_blockid [required]string
The queue ID the interactions were added to.
type [required]enum
Resource type for annotation queue interactions.
Allowed enum values:
interactions{
"data": {
"attributes": {
"interactions": [
{
"already_existed": false,
"content_id": "trace-abc-123",
"created_at": "2024-01-15T10:30:00Z",
"id": "00000000-0000-0000-0000-000000000000",
"modified_at": "2024-01-15T10:30:00Z",
"type": "trace"
}
]
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "interactions"
}
}Bad Request
API error response.
フィールド
タイプ
説明
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Unauthorized
API error response.
フィールド
タイプ
説明
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Forbidden
API error response.
フィールド
タイプ
説明
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Not Found
API error response.
フィールド
タイプ
説明
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}コード例
Add annotation queue interactions
## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOF## default
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"content_id": "trace-abc-123",
"type": "trace"
}
]
},
"type": "interactions"
}
}
EOF
## Add a display_block interaction
# Path parameters
export queue_id="00000000-0000-0000-0000-000000000001"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/llm-obs/v1/annotation-queues/${queue_id}/interactions" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"interactions": [
{
"display_block": [
{
"content": "## Triage Instructions",
"type": "markdown"
},
{
"content": "Inputs",
"level": "md",
"type": "header"
},
{
"content": {
"experiment_id": "abc-123"
},
"label": "Experiments",
"type": "json"
},
{
"code": "<div class=\"status-card\">Ready for review</div>",
"label": "Review status",
"type": "frontend"
}
],
"type": "display_block"
}
]
},
"type": "interactions"
}
}
EOFAdd annotation queue interactions
// Add annotation queue interactions returns "Created" response
package main
import (
"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"
)
func main() {
body := datadogV2.LLMObsAnnotationQueueInteractionsRequest{
Data: datadogV2.LLMObsAnnotationQueueInteractionsDataRequest{
Attributes: datadogV2.LLMObsAnnotationQueueInteractionsDataAttributesRequest{
Interactions: []datadogV2.LLMObsAnnotationQueueInteractionItem{
datadogV2.LLMObsAnnotationQueueInteractionItem{
LLMObsTraceInteractionItem: &datadogV2.LLMObsTraceInteractionItem{
ContentId: "trace-abc-123",
Type: datadogV2.LLMOBSTRACEINTERACTIONTYPE_TRACE,
}},
},
},
Type: datadogV2.LLMOBSANNOTATIONQUEUEINTERACTIONSTYPE_INTERACTIONS,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.CreateLLMObsAnnotationQueueInteractions", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewAgentObservabilityApi(apiClient)
resp, r, err := api.CreateLLMObsAnnotationQueueInteractions(ctx, "queue_id", body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AgentObservabilityApi.CreateLLMObsAnnotationQueueInteractions`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `AgentObservabilityApi.CreateLLMObsAnnotationQueueInteractions`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Add annotation queue interactions
// Add annotation queue interactions returns "Created" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AgentObservabilityApi;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionItem;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsDataRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsRequest;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsResponse;
import com.datadog.api.client.v2.model.LLMObsAnnotationQueueInteractionsType;
import com.datadog.api.client.v2.model.LLMObsTraceInteractionItem;
import com.datadog.api.client.v2.model.LLMObsTraceInteractionType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.createLLMObsAnnotationQueueInteractions", true);
AgentObservabilityApi apiInstance = new AgentObservabilityApi(defaultClient);
LLMObsAnnotationQueueInteractionsRequest body =
new LLMObsAnnotationQueueInteractionsRequest()
.data(
new LLMObsAnnotationQueueInteractionsDataRequest()
.attributes(
new LLMObsAnnotationQueueInteractionsDataAttributesRequest()
.interactions(
Collections.singletonList(
new LLMObsAnnotationQueueInteractionItem(
new LLMObsTraceInteractionItem()
.contentId("trace-abc-123")
.type(LLMObsTraceInteractionType.TRACE)))))
.type(LLMObsAnnotationQueueInteractionsType.INTERACTIONS));
try {
LLMObsAnnotationQueueInteractionsResponse result =
apiInstance.createLLMObsAnnotationQueueInteractions(
"00000000-0000-0000-0000-000000000001", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling AgentObservabilityApi#createLLMObsAnnotationQueueInteractions");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Add annotation queue interactions
"""
Add annotation queue interactions returns "Created" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agent_observability_api import AgentObservabilityApi
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_attributes_request import (
LLMObsAnnotationQueueInteractionsDataAttributesRequest,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_data_request import (
LLMObsAnnotationQueueInteractionsDataRequest,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_request import (
LLMObsAnnotationQueueInteractionsRequest,
)
from datadog_api_client.v2.model.llm_obs_annotation_queue_interactions_type import LLMObsAnnotationQueueInteractionsType
from datadog_api_client.v2.model.llm_obs_trace_interaction_item import LLMObsTraceInteractionItem
from datadog_api_client.v2.model.llm_obs_trace_interaction_type import LLMObsTraceInteractionType
body = LLMObsAnnotationQueueInteractionsRequest(
data=LLMObsAnnotationQueueInteractionsDataRequest(
attributes=LLMObsAnnotationQueueInteractionsDataAttributesRequest(
interactions=[
LLMObsTraceInteractionItem(
content_id="trace-abc-123",
type=LLMObsTraceInteractionType.TRACE,
),
],
),
type=LLMObsAnnotationQueueInteractionsType.INTERACTIONS,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["create_llm_obs_annotation_queue_interactions"] = True
with ApiClient(configuration) as api_client:
api_instance = AgentObservabilityApi(api_client)
response = api_instance.create_llm_obs_annotation_queue_interactions(queue_id="queue_id", body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Add annotation queue interactions
# Add annotation queue interactions returns "Created" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.create_llm_obs_annotation_queue_interactions".to_sym] = true
end
api_instance = DatadogAPIClient::V2::AgentObservabilityAPI.new
body = DatadogAPIClient::V2::LLMObsAnnotationQueueInteractionsRequest.new({
data: DatadogAPIClient::V2::LLMObsAnnotationQueueInteractionsDataRequest.new({
attributes: DatadogAPIClient::V2::LLMObsAnnotationQueueInteractionsDataAttributesRequest.new({
interactions: [
DatadogAPIClient::V2::LLMObsTraceInteractionItem.new({
content_id: "trace-abc-123",
type: DatadogAPIClient::V2::LLMObsTraceInteractionType::TRACE,
}),
],
}),
type: DatadogAPIClient::V2::LLMObsAnnotationQueueInteractionsType::INTERACTIONS,
}),
})
p api_instance.create_llm_obs_annotation_queue_interactions("queue_id", body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Add annotation queue interactions
// Add annotation queue interactions returns "Created" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_agent_observability::AgentObservabilityAPI;
use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionItem;
use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsDataAttributesRequest;
use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsDataRequest;
use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsRequest;
use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsType;
use datadog_api_client::datadogV2::model::LLMObsTraceInteractionItem;
use datadog_api_client::datadogV2::model::LLMObsTraceInteractionType;
#[tokio::main]
async fn main() {
let body = LLMObsAnnotationQueueInteractionsRequest::new(
LLMObsAnnotationQueueInteractionsDataRequest::new(
LLMObsAnnotationQueueInteractionsDataAttributesRequest::new(vec![
LLMObsAnnotationQueueInteractionItem::LLMObsTraceInteractionItem(Box::new(
LLMObsTraceInteractionItem::new(
"trace-abc-123".to_string(),
LLMObsTraceInteractionType::TRACE,
),
)),
]),
LLMObsAnnotationQueueInteractionsType::INTERACTIONS,
),
);
let mut configuration = datadog::Configuration::new();
configuration
.set_unstable_operation_enabled("v2.create_llm_obs_annotation_queue_interactions", true);
let api = AgentObservabilityAPI::with_config(configuration);
let resp = api
.create_llm_obs_annotation_queue_interactions("queue_id".to_string(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runAdd annotation queue interactions
/**
* Add annotation queue interactions returns "Created" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations["v2.createLLMObsAnnotationQueueInteractions"] =
true;
const apiInstance = new v2.AgentObservabilityApi(configuration);
const params: v2.AgentObservabilityApiCreateLLMObsAnnotationQueueInteractionsRequest =
{
body: {
data: {
attributes: {
interactions: [
{
contentId: "trace-abc-123",
type: "trace",
},
],
},
type: "interactions",
},
},
queueId: "queue_id",
};
apiInstance
.createLLMObsAnnotationQueueInteractions(params)
.then((data: v2.LLMObsAnnotationQueueInteractionsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"