From b8e68abff1af2241854b5abc7ba5d66e29a15392 Mon Sep 17 00:00:00 2001 From: johannzhang8 Date: Thu, 3 Sep 2026 09:04:35 -0400 Subject: [PATCH 1/3] ECI-1923 add section about stack destroy issues to troubleshooting docs (#39678) * add section about stack destroy issues * make list, formatting changes --- .../guide/oci-integration-troubleshooting.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/hugo/content/en/integrations/guide/oci-integration-troubleshooting.md b/hugo/content/en/integrations/guide/oci-integration-troubleshooting.md index 2239be94465..0b23547f9b1 100644 --- a/hugo/content/en/integrations/guide/oci-integration-troubleshooting.md +++ b/hugo/content/en/integrations/guide/oci-integration-troubleshooting.md @@ -78,6 +78,37 @@ Complete the following checks for each monitored region: 3. If you use custom subnets, verify that they meet the [permissions][7] (detailed in the note after step 5). 4. For each Datadog-created metric service connector hub, confirm that its function target is the `dd-metrics-forwarder` function in `dd-function-app`. Datadog-created metric connector hubs use the format `dd-metrics-connectorhub-`. If a connector hub targets a different forwarding function application, delete it and allow it to be automatically reprovisioned. +## OCI stack destroy issues + +If the destroy job fails or is unable to be run: + +1. Clone the [OCI integration repository][11] and enter the repository directory. +2. Use the [OCI integration cleanup script][10] to remove the remaining resources. +3. Set the required variables. +4. Review a dry run: + + ```shell + export OCI_PROFILE="" + export COMPARTMENT_OCID="" + export TENANCY_OCID="" + + python3 oci-integration-cleanup/integration_cleanup.py \ + --profile "$OCI_PROFILE" \ + --compartment-ocid "$COMPARTMENT_OCID" \ + --dry-run true + ``` + +5. Review the resources planned for deletion in the dry run output. If the output looks correct, execute the cleanup: + + ```shell + python3 oci-integration-cleanup/integration_cleanup.py \ + --profile "$OCI_PROFILE" \ + --compartment-ocid "$COMPARTMENT_OCID" \ + --confirm-tenancy-id "$TENANCY_OCID" \ + --region-workers \ + --dry-run false + ``` + ## Outdated integration version This occurs when your Datadog integration ORM stack or Terraform module is out of date. To remediate this, update your deployment to the latest version and reapply it. For instructions covering both QuickStart (ORM stack) and Terraform, see [Update the integration][8]. @@ -93,3 +124,5 @@ Still need help? Contact [Datadog support][3]. [7]: https://docs.datadoghq.com/integrations/oracle-cloud-infrastructure/#deploy-the-quickstart-orm-stack [8]: /integrations/oracle-cloud-infrastructure/#update-the-integration [9]: https://app.datadoghq.com/organization-settings/application-keys +[10]: https://github.com/DataDog/oracle-cloud-integration/tree/master/oci-integration-cleanup#readme +[11]: https://github.com/DataDog/oracle-cloud-integration From 0d9cd82a10f9f4f64bcf83e671a4f95a315ba784 Mon Sep 17 00:00:00 2001 From: StefonSimmons <57869435+StefonSimmons@users.noreply.github.com> Date: Thu, 3 Sep 2026 09:27:11 -0400 Subject: [PATCH 2/3] rm datadog-ci (#39662) --- .../py/build/configurations/pull_config.yaml | 52 ------------------ .../configurations/pull_config_preview.yaml | 54 +------------------ 2 files changed, 1 insertion(+), 105 deletions(-) diff --git a/hugo/local/bin/py/build/configurations/pull_config.yaml b/hugo/local/bin/py/build/configurations/pull_config.yaml index f8dd052488a..6d14bb7c6f3 100644 --- a/hugo/local/bin/py/build/configurations/pull_config.yaml +++ b/hugo/local/bin/py/build/configurations/pull_config.yaml @@ -156,58 +156,6 @@ aliases: - /serverless/serverless_integrations/macro/ - - repo_name: datadog-ci - contents: - - action: pull-and-push-file - branch: master - globs: - - 'packages/plugin-lambda/README.md' - options: - dest_path: '/serverless/libraries_integrations/' - file_name: 'cli.md' - front_matters: - dependencies: ["https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-lambda/README.md"] - title: Datadog Serverless CLI - aliases: - - /serverless/datadog_lambda_library/ - - /serverless/serverless_integrations/cli/ - - action: pull-and-push-file - branch: master - globs: - - 'packages/plugin-cloud-run/README.md' - options: - dest_path: '/serverless/libraries_integrations/' - file_name: 'cli-cloud-run.md' - front_matters: - dependencies: ["https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-cloud-run/README.md"] - title: Datadog Serverless CLI for Cloud Run - - action: pull-and-push-file - branch: master - globs: - - 'packages/plugin-synthetics/README.md' - options: - dest_path: '/continuous_testing/cicd_integrations/' - file_name: 'configuration.md' - front_matters: - dependencies: ["https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-synthetics/README.md"] - title: Continuous Testing and CI/CD Configuration - description: Configure Continuous Testing to run tests in your CI/CD pipelines. - aliases: - - /synthetics/cicd_integrations/configuration - further_reading: - - link: "https://www.datadoghq.com/blog/datadog-github-action-synthetics-ci-visibility/" - tag: "Blog" - text: "Use Datadog's GitHub Action to add continuous testing to workflows" - - link: "/continuous_testing/cicd_integrations" - tag: "Documentation" - text: "Learn about Continuous Testing and CI/CD" - - link: "/continuous_testing/explorer" - tag: "Documentation" - text: "Learn about the Synthetic Monitoring & Testing Results Explorer" - - link: "/continuous_testing/testing_tunnel" - tag: "Documentation" - text: "Learn about the Continuous Testing Tunnel" - - repo_name: datadog-cdk-constructs contents: - action: pull-and-push-file diff --git a/hugo/local/bin/py/build/configurations/pull_config_preview.yaml b/hugo/local/bin/py/build/configurations/pull_config_preview.yaml index d7280e005a2..79061cc1233 100644 --- a/hugo/local/bin/py/build/configurations/pull_config_preview.yaml +++ b/hugo/local/bin/py/build/configurations/pull_config_preview.yaml @@ -182,59 +182,7 @@ title: Datadog Serverless Macro aliases: - /serverless/serverless_integrations/macro/ - - - repo_name: datadog-ci - contents: - - action: pull-and-push-file - branch: master - globs: - - 'packages/plugin-lambda/README.md' - options: - dest_path: '/serverless/libraries_integrations/' - file_name: 'cli.md' - front_matters: - dependencies: ["https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-lambda/README.md"] - title: Datadog Serverless CLI - aliases: - - /serverless/datadog_lambda_library/ - - /serverless/serverless_integrations/cli/ - - action: pull-and-push-file - branch: master - globs: - - 'packages/plugin-cloud-run/README.md' - options: - dest_path: '/serverless/libraries_integrations/' - file_name: 'cli-cloud-run.md' - front_matters: - dependencies: ["https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-cloud-run/README.md"] - title: Datadog Serverless CLI for Cloud Run - - action: pull-and-push-file - branch: master - globs: - - 'packages/plugin-synthetics/README.md' - options: - dest_path: '/continuous_testing/cicd_integrations/' - file_name: 'configuration.md' - front_matters: - dependencies: ["https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-synthetics/README.md"] - title: Continuous Testing and CI/CD Configuration - description: Configure Continuous Testing to run tests in your CI/CD pipelines. - aliases: - - /synthetics/cicd_integrations/configuration - further_reading: - - link: "https://www.datadoghq.com/blog/datadog-github-action-synthetics-ci-visibility/" - tag: "Blog" - text: "Use Datadog's GitHub Action to add continuous testing to workflows" - - link: "/continuous_testing/cicd_integrations" - tag: "Documentation" - text: "Learn about Continuous Testing and CI/CD" - - link: "/continuous_testing/explorer" - tag: "Documentation" - text: "Learn about the Synthetic Monitoring & Testing Results Explorer" - - link: "/continuous_testing/testing_tunnel" - tag: "Documentation" - text: "Learn about the Testing Tunnel" - + - repo_name: datadog-cdk-constructs contents: - action: pull-and-push-file From 327f560a505fa472a640a42abdefc6c60f6d69cf Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Thu, 3 Sep 2026 09:43:02 -0400 Subject: [PATCH 3/3] Regenerate client from commit 52bead2 of spec repo (#39648) Co-authored-by: ci.datadog-api-spec --- hugo/config/_default/menus/api.en.yaml | 13 ++ .../index.md | 3 + .../api/v2/agent-observability/examples.json | 139 +++++++++++++ hugo/data/api/v2/full_spec.yaml | 184 ++++++++++++++++++ hugo/data/api/v2/translate_actions.json | 4 + 5 files changed, 343 insertions(+) create mode 100644 hugo/content/en/api/latest/agent-observability/get-an-annotated-queue-interaction/index.md diff --git a/hugo/config/_default/menus/api.en.yaml b/hugo/config/_default/menus/api.en.yaml index d86e3b6447c..fa2aa4c0d46 100644 --- a/hugo/config/_default/menus/api.en.yaml +++ b/hugo/config/_default/menus/api.en.yaml @@ -8480,6 +8480,19 @@ menu: unstable: - v2 order: 28 + - name: Get an annotated queue interaction + url: /api/latest/agent-observability/get-an-annotated-queue-interaction/ + identifier: agent-observability-get-an-annotated-queue-interaction + parent: agent-observability + generated: true + params: + versions: + - v2 + operationids: + - GetLLMObsAnnotatedInteraction + unstable: + - v2 + order: 73 - name: Get annotated queue interactions url: /api/latest/agent-observability/get-annotated-queue-interactions/ identifier: agent-observability-get-annotated-queue-interactions diff --git a/hugo/content/en/api/latest/agent-observability/get-an-annotated-queue-interaction/index.md b/hugo/content/en/api/latest/agent-observability/get-an-annotated-queue-interaction/index.md new file mode 100644 index 00000000000..f5a6bbeb10b --- /dev/null +++ b/hugo/content/en/api/latest/agent-observability/get-an-annotated-queue-interaction/index.md @@ -0,0 +1,3 @@ +--- +title: Get an annotated queue interaction +--- diff --git a/hugo/content/en/api/v2/agent-observability/examples.json b/hugo/content/en/api/v2/agent-observability/examples.json index c623d586b90..7a7d88bb003 100644 --- a/hugo/content/en/api/v2/agent-observability/examples.json +++ b/hugo/content/en/api/v2/agent-observability/examples.json @@ -1464,6 +1464,145 @@ "html": "" } }, + "GetLLMObsAnnotatedInteraction": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "annotated_interaction": { + "annotations": [ + { + "created_at": "2024-01-15T10:30:00Z", + "created_by": "00000000-0000-0000-0000-000000000002", + "id": "annotation-789", + "interaction_id": "interaction-456", + "label_values": [ + {} + ], + "modified_at": "2024-01-15T10:30:00Z", + "modified_by": "00000000-0000-0000-0000-000000000002" + } + ], + "can_annotate": true, + "content_id": "trace-abc-123", + "created_at": "2024-01-15T10:30:00Z", + "id": "interaction-456", + "modified_at": "2024-01-15T10:30:00Z", + "type": "trace" + }, + "events": [ + { + "attributes": { + "duration": 1500000000, + "ml_app": "my-llm-app", + "name": "agent_workflow", + "span_id": "span-7a1b2c3d", + "span_kind": "agent", + "start_ns": 1705314600000000000, + "status": "ok", + "trace_id": "trace-abc-123" + }, + "id": "span-7a1b2c3d", + "type": "span" + } + ], + "interaction_type": "trace", + "next_cursor": "eyJzdGFydCI6MTAwfQ==" + }, + "id": "interaction-456", + "type": "annotated_interactions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object for a single annotated interaction.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes containing an annotated interaction and its related events.

\n
\n
\n
\n
\n
\n

annotated_interaction [required]

\n
\n

 <oneOf>

\n

An interaction with its associated annotations.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

A trace, experiment trace, or session interaction with its associated annotations.

\n
\n
\n
\n
\n
\n

annotations [required]

\n
\n

[object]

\n

List of annotations for this interaction.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the annotation was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

string

\n

Identifier of the user who created the annotation.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the annotation.

\n
\n \n
\n
\n
\n
\n
\n

interaction_id [required]

\n
\n

string

\n

Identifier of the interaction this annotation belongs to.

\n
\n \n
\n
\n
\n
\n
\n

label_values [required]

\n
\n

object

\n

Label values for this annotation.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the annotation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

string

\n

Identifier of the user who last modified the annotation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

can_annotate [required]

\n
\n

boolean

\n

Whether the current caller can annotate this interaction.

\n
\n \n
\n
\n
\n
\n
\n

content_id [required]

\n
\n

string

\n

Upstream entity identifier supplied by the caller.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the interaction was added to the queue.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the interaction.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the interaction was last updated.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=display_block>

\n
\n

object

\n

A display_block interaction with its associated annotations.

\n
\n
\n
\n
\n
\n

annotations [required]

\n
\n

[object]

\n

List of annotations for this interaction.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

Timestamp when the annotation was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

string

\n

Identifier of the user who created the annotation.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the annotation.

\n
\n \n
\n
\n
\n
\n
\n

interaction_id [required]

\n
\n

string

\n

Identifier of the interaction this annotation belongs to.

\n
\n \n
\n
\n
\n
\n
\n

label_values [required]

\n
\n

object

\n

Label values for this annotation.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

Timestamp when the annotation was last modified.

\n
\n \n
\n
\n
\n
\n
\n

modified_by [required]

\n
\n

string

\n

Identifier of the user who last modified the annotation.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

can_annotate [required]

\n
\n

boolean

\n

Whether the current caller can annotate this interaction.

\n
\n \n
\n
\n
\n
\n
\n

content_id [required]

\n
\n

string

\n

Server-generated deterministic identifier derived from the block list.

\n
\n \n
\n
\n
\n
\n
\n

display_block [required]

\n
\n

[object]

\n

List of content blocks that make up a display_block interaction.\nMust contain at least one block.

\n
\n
\n
\n
\n
\n

alt

\n
\n

string

\n

Alternative text for an image block.

\n
\n \n
\n
\n
\n
\n
\n

content

\n
\n

\n

Block payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.

\n
\n \n
\n
\n
\n
\n
\n

height

\n
\n

int64

\n

Optional rendered height. Must be positive when set.

\n
\n \n
\n
\n
\n
\n
\n

interactionType

\n
\n

enum

\n

Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

Optional label rendered alongside the block.

\n
\n \n
\n
\n
\n
\n
\n

level

\n
\n

enum

\n

Visual size for a header block. \nAllowed enum values: sm,md,lg,xl

\n
\n \n
\n
\n
\n
\n
\n

tileDef

\n
\n

\n

Tile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.

\n
\n \n
\n
\n
\n
\n
\n

timeFrame

\n
\n

object

\n

Unix-millis time range used by chart blocks.

\n
\n
\n
\n
\n
\n

end [required]

\n
\n

int64

\n

End of the range, in Unix milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

start [required]

\n
\n

int64

\n

Start of the range, in Unix milliseconds.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traceId

\n
\n

string

\n

Trace identifier. Required for llmobs_trace blocks.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace

\n
\n \n
\n
\n
\n
\n
\n

url

\n
\n

string

\n

URL of the image. Required for image blocks.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the interaction.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type discriminator for a display_block interaction. \nAllowed enum values: display_block

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

events [required]

\n
\n

[object]

\n

Page of events associated with the annotated interaction.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of an event associated with an annotated interaction.

\n
\n \n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the event.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Type of the event.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

interaction_type [required]

\n
\n

enum

\n

Type of an annotated interaction. \nAllowed enum values: trace,experiment_trace,session,display_block

\n
\n \n
\n
\n
\n
\n
\n

next_cursor

\n
\n

string

\n

Cursor to retrieve the next page of events. Absent when there are no more events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique identifier of the interaction.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Resource type for annotated interactions. \nAllowed enum values: annotated_interactions

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "UpsertLLMObsAnnotations": { "responses": { "200": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 31fa7147d55..a4ea11bf1d4 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -988,6 +988,14 @@ components: required: true schema: type: string + LLMObsAnnotationQueueInteractionIDPathParameter: + description: The ID of the interaction in the annotation queue. + example: "interaction-456" + in: path + name: interaction_id + required: true + schema: + type: string LLMObsDatasetIDPathParameter: description: The ID of the Agent Observability dataset. example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" @@ -56780,11 +56788,89 @@ components: - can_annotate - annotations type: object + LLMObsAnnotatedInteractionDataAttributesResponse: + description: Attributes containing an annotated interaction and its related events. + properties: + annotated_interaction: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionItem" + events: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionEvents" + interaction_type: + $ref: "#/components/schemas/LLMObsAnyInteractionType" + next_cursor: + description: Cursor to retrieve the next page of events. Absent when there are no more events. + example: "eyJzdGFydCI6MTAwfQ==" + type: string + required: + - annotated_interaction + - interaction_type + - events + type: object + LLMObsAnnotatedInteractionDataResponse: + description: Data object for a single annotated interaction. + properties: + attributes: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionDataAttributesResponse" + id: + description: Unique identifier of the interaction. + example: "interaction-456" + type: string + type: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionsType" + required: + - id + - type + - attributes + type: object + LLMObsAnnotatedInteractionEvent: + description: An event associated with an annotated interaction. + properties: + attributes: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionEventAttributes" + id: + description: Unique identifier of the event. + example: "span-7a1b2c3d" + type: string + type: + description: Type of the event. + example: span + type: string + required: + - id + - type + - attributes + type: object + LLMObsAnnotatedInteractionEventAttributes: + additionalProperties: {} + description: Attributes of an event associated with an annotated interaction. + example: + duration: 1500000000 + ml_app: my-llm-app + name: agent_workflow + span_id: span-7a1b2c3d + span_kind: agent + start_ns: 1705314600000000000 + status: ok + trace_id: trace-abc-123 + type: object + LLMObsAnnotatedInteractionEvents: + description: Page of events associated with the annotated interaction. + items: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionEvent" + type: array LLMObsAnnotatedInteractionItem: description: An interaction with its associated annotations. oneOf: - $ref: "#/components/schemas/LLMObsTraceAnnotatedInteractionItem" - $ref: "#/components/schemas/LLMObsDisplayBlockAnnotatedInteractionItem" + LLMObsAnnotatedInteractionResponse: + description: Response containing a single annotated interaction and its related events. + properties: + data: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionDataResponse" + required: + - data + type: object LLMObsAnnotatedInteractionsByTraceDataAttributesResponse: description: Attributes of the cross-queue annotated interactions response. properties: @@ -168519,6 +168605,104 @@ paths: x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotated-interactions/{interaction_id}: + get: + description: Retrieve an interaction, its annotations, and a page of related events from an annotation queue. + operationId: GetLLMObsAnnotatedInteraction + parameters: + - $ref: "#/components/parameters/LLMObsAnnotationQueueIDPathParameter" + - $ref: "#/components/parameters/LLMObsAnnotationQueueInteractionIDPathParameter" + - description: Maximum number of events to return. Defaults to 10. + in: query + name: limit + schema: + default: 10 + format: int32 + maximum: 1000 + minimum: 1 + type: integer + - description: Cursor from the previous response to retrieve the next page of events. + in: query + name: cursor + schema: + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + annotated_interaction: + annotations: [] + can_annotate: true + content_id: trace-abc-123 + created_at: "2024-01-15T10:30:00Z" + id: interaction-456 + modified_at: "2024-01-15T10:30:00Z" + type: trace + events: + - attributes: + duration: 1500000000 + ml_app: my-llm-app + name: agent_workflow + span_id: span-7a1b2c3d + span_kind: agent + start_ns: 1705314600000000000 + status: ok + trace_id: trace-abc-123 + id: span-7a1b2c3d + type: span + interaction_type: session + next_cursor: eyJzdGFydCI6MTAwfQ== + id: interaction-456 + type: annotated_interactions + schema: + $ref: "#/components/schemas/LLMObsAnnotatedInteractionResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get an annotated queue interaction + tags: + - Agent Observability + x-menu-order: 73 + x-pagination: + cursorParam: cursor + cursorPath: data.attributes.next_cursor + limitParam: limit + resultsPath: data.attributes.events + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/llm-obs/v1/annotation-queues/{queue_id}/annotations: post: description: |- diff --git a/hugo/data/api/v2/translate_actions.json b/hugo/data/api/v2/translate_actions.json index 31d9256eb4d..5e0c5efc128 100644 --- a/hugo/data/api/v2/translate_actions.json +++ b/hugo/data/api/v2/translate_actions.json @@ -3369,6 +3369,10 @@ "description": "Retrieve all interactions (traces and sessions) and their annotations for a given annotation queue.", "summary": "Get annotated queue interactions" }, + "GetLLMObsAnnotatedInteraction": { + "description": "Retrieve an interaction, its annotations, and a page of related events from an annotation queue.", + "summary": "Get an annotated queue interaction" + }, "UpsertLLMObsAnnotations": { "description": "Create or update annotations on interactions in a queue. Each annotation is matched\nby `interaction_id` and the requesting user's identity.\nResults and errors in the response are linked to request items by `interaction_id`.\nErrors for individual items are returned in the `errors` field without blocking the rest of the batch.\nRequests where every item is denied by queue access rules return `403`.", "summary": "Create or update annotations",