Agent Observability 실험 검색

v2 (latest)

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

POST https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.ap2.datadoghq.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.datadoghq.eu/api/v2/llm-obs/v1/experimentation/searchhttps://api.ddog-gov.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.us2.ddog-gov.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.uk1.datadoghq.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.datadoghq.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.us3.datadoghq.com/api/v2/llm-obs/v1/experimentation/searchhttps://api.us5.datadoghq.com/api/v2/llm-obs/v1/experimentation/search

개요

Search across Agent Observability experimentation entities — projects, datasets, dataset records, experiments, and experiment runs — using cursor-based pagination.

The filter.scope field controls which entity types are returned. At least one valid scope must be provided.

Returns 200 OK when all results fit in a single page. Returns 206 Partial Content with a cursor in meta.after when additional pages are available.

요청

Body Data (required)

Experimentation search payload.

Expand All

항목

유형

설명

data [required]

object

Data object for an experimentation search request.

{
  "data": {
    "attributes": {
      "content_preview": {
        "limit": 500
      },
      "filter": {
        "include_deleted": false,
        "is_deleted": false,
        "query": "my experiment",
        "scope": [
          "experiments"
        ],
        "version": "integer"
      },
      "include": {
        "user_data": false
      },
      "page": {
        "cursor": "string",
        "limit": 100
      }
    },
    "type": "experimentation"
  }
}

응답

OK — all results returned in a single page.

Response to a cursor-based experimentation search. Returns 200 OK when all results fit in one page; 206 Partial Content when a next-page cursor is available.

Expand All

항목

유형

설명

data [required]

object

JSON:API data object for an experimentation search response.

attributes [required]

object

The matching experimentation entities grouped by type.

코드 사례

                  ## default
# 

# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/llm-obs/v1/experimentation/search" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "filter": {
        "query": "@project_id:a33671aa-24fd-4dcd-9b33-a8ec7dde7751",
        "scope": [
          "experiments"
        ]
      },
      "page": {
        "limit": 50
      }
    },
    "type": "experimentation"
  }
}
EOF

                

"""
Search Agent Observability experimentation returns "Partial Content — more results are available. Use `meta.after` as
the next `page.cursor`." response
"""

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_experimentation_content_preview import LLMObsExperimentationContentPreview
from datadog_api_client.v2.model.llm_obs_experimentation_cursor_page import LLMObsExperimentationCursorPage
from datadog_api_client.v2.model.llm_obs_experimentation_filter import LLMObsExperimentationFilter
from datadog_api_client.v2.model.llm_obs_experimentation_include import LLMObsExperimentationInclude
from datadog_api_client.v2.model.llm_obs_experimentation_search_data_attributes_request import (
    LLMObsExperimentationSearchDataAttributesRequest,
)
from datadog_api_client.v2.model.llm_obs_experimentation_search_data_request import (
    LLMObsExperimentationSearchDataRequest,
)
from datadog_api_client.v2.model.llm_obs_experimentation_search_request import LLMObsExperimentationSearchRequest
from datadog_api_client.v2.model.llm_obs_experimentation_type import LLMObsExperimentationType

body = LLMObsExperimentationSearchRequest(
    data=LLMObsExperimentationSearchDataRequest(
        attributes=LLMObsExperimentationSearchDataAttributesRequest(
            content_preview=LLMObsExperimentationContentPreview(
                limit=500,
            ),
            filter=LLMObsExperimentationFilter(
                include_deleted=False,
                is_deleted=False,
                query="my experiment",
                scope=[
                    "experiments",
                ],
                version=None,
            ),
            include=LLMObsExperimentationInclude(
                user_data=False,
            ),
            page=LLMObsExperimentationCursorPage(
                limit=100,
            ),
        ),
        type=LLMObsExperimentationType.EXPERIMENTATION,
    ),
)

configuration = Configuration()
configuration.unstable_operations["search_llm_obs_experimentation"] = True
with ApiClient(configuration) as api_client:
    api_instance = AgentObservabilityApi(api_client)
    response = api_instance.search_llm_obs_experimentation(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.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>" python3 "example.py"

# Search Agent Observability experimentation returns "Partial Content — more results are available. Use `meta.after` as
# the next `page.cursor`." response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.search_llm_obs_experimentation".to_sym] = true
end
api_instance = DatadogAPIClient::V2::AgentObservabilityAPI.new

body = DatadogAPIClient::V2::LLMObsExperimentationSearchRequest.new({
  data: DatadogAPIClient::V2::LLMObsExperimentationSearchDataRequest.new({
    attributes: DatadogAPIClient::V2::LLMObsExperimentationSearchDataAttributesRequest.new({
      content_preview: DatadogAPIClient::V2::LLMObsExperimentationContentPreview.new({
        limit: 500,
      }),
      filter: DatadogAPIClient::V2::LLMObsExperimentationFilter.new({
        include_deleted: false,
        is_deleted: false,
        query: "my experiment",
        scope: [
          "experiments",
        ],
        version: nil,
      }),
      include: DatadogAPIClient::V2::LLMObsExperimentationInclude.new({
        user_data: false,
      }),
      page: DatadogAPIClient::V2::LLMObsExperimentationCursorPage.new({
        limit: 100,
      }),
    }),
    type: DatadogAPIClient::V2::LLMObsExperimentationType::EXPERIMENTATION,
  }),
})
p api_instance.search_llm_obs_experimentation(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    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>" rb "example.rb"

// Search Agent Observability experimentation returns "Partial Content — more results are available. Use `meta.after` as
// the next `page.cursor`." 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.LLMObsExperimentationSearchRequest{
		Data: datadogV2.LLMObsExperimentationSearchDataRequest{
			Attributes: datadogV2.LLMObsExperimentationSearchDataAttributesRequest{
				ContentPreview: &datadogV2.LLMObsExperimentationContentPreview{
					Limit: datadog.PtrInt64(500),
				},
				Filter: datadogV2.LLMObsExperimentationFilter{
					IncludeDeleted: datadog.PtrBool(false),
					IsDeleted:      datadog.PtrBool(false),
					Query:          datadog.PtrString("my experiment"),
					Scope: []string{
						"experiments",
					},
					Version: *datadog.NewNullableInt64(nil),
				},
				Include: &datadogV2.LLMObsExperimentationInclude{
					UserData: datadog.PtrBool(false),
				},
				Page: &datadogV2.LLMObsExperimentationCursorPage{
					Limit: datadog.PtrInt64(100),
				},
			},
			Type: datadogV2.LLMOBSEXPERIMENTATIONTYPE_EXPERIMENTATION,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	configuration := datadog.NewConfiguration()
	configuration.SetUnstableOperationEnabled("v2.SearchLLMObsExperimentation", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewAgentObservabilityApi(apiClient)
	resp, r, err := api.SearchLLMObsExperimentation(ctx, body)

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AgentObservabilityApi.SearchLLMObsExperimentation`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `AgentObservabilityApi.SearchLLMObsExperimentation`:\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.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>" go run "main.go"

// Search Agent Observability experimentation returns "Partial Content — more results are available.
// Use `meta.after` as
// the next `page.cursor`." 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.LLMObsExperimentationContentPreview;
import com.datadog.api.client.v2.model.LLMObsExperimentationCursorPage;
import com.datadog.api.client.v2.model.LLMObsExperimentationFilter;
import com.datadog.api.client.v2.model.LLMObsExperimentationInclude;
import com.datadog.api.client.v2.model.LLMObsExperimentationSearchDataAttributesRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentationSearchDataRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentationSearchRequest;
import com.datadog.api.client.v2.model.LLMObsExperimentationSearchResponse;
import com.datadog.api.client.v2.model.LLMObsExperimentationType;
import java.util.Collections;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.searchLLMObsExperimentation", true);
    AgentObservabilityApi apiInstance = new AgentObservabilityApi(defaultClient);

    LLMObsExperimentationSearchRequest body =
        new LLMObsExperimentationSearchRequest()
            .data(
                new LLMObsExperimentationSearchDataRequest()
                    .attributes(
                        new LLMObsExperimentationSearchDataAttributesRequest()
                            .contentPreview(new LLMObsExperimentationContentPreview().limit(500L))
                            .filter(
                                new LLMObsExperimentationFilter()
                                    .includeDeleted(false)
                                    .isDeleted(false)
                                    .query("my experiment")
                                    .scope(Collections.singletonList("experiments"))
                                    .version(null))
                            .include(new LLMObsExperimentationInclude().userData(false))
                            .page(new LLMObsExperimentationCursorPage().limit(100L)))
                    .type(LLMObsExperimentationType.EXPERIMENTATION));

    try {
      LLMObsExperimentationSearchResponse result = apiInstance.searchLLMObsExperimentation(body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println(
          "Exception when calling AgentObservabilityApi#searchLLMObsExperimentation");
      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.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>" java "Example.java"

// Search Agent Observability experimentation returns "Partial Content — more
// results are available. Use `meta.after` as the next `page.cursor`." response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_agent_observability::AgentObservabilityAPI;
use datadog_api_client::datadogV2::model::LLMObsExperimentationContentPreview;
use datadog_api_client::datadogV2::model::LLMObsExperimentationCursorPage;
use datadog_api_client::datadogV2::model::LLMObsExperimentationFilter;
use datadog_api_client::datadogV2::model::LLMObsExperimentationInclude;
use datadog_api_client::datadogV2::model::LLMObsExperimentationSearchDataAttributesRequest;
use datadog_api_client::datadogV2::model::LLMObsExperimentationSearchDataRequest;
use datadog_api_client::datadogV2::model::LLMObsExperimentationSearchRequest;
use datadog_api_client::datadogV2::model::LLMObsExperimentationType;

#[tokio::main]
async fn main() {
    let body =
        LLMObsExperimentationSearchRequest::new(LLMObsExperimentationSearchDataRequest::new(
            LLMObsExperimentationSearchDataAttributesRequest::new(
                LLMObsExperimentationFilter::new(vec!["experiments".to_string()])
                    .include_deleted(false)
                    .is_deleted(false)
                    .query("my experiment".to_string())
                    .version(None),
            )
            .content_preview(LLMObsExperimentationContentPreview::new().limit(500))
            .include(LLMObsExperimentationInclude::new().user_data(false))
            .page(LLMObsExperimentationCursorPage::new().limit(100)),
            LLMObsExperimentationType::EXPERIMENTATION,
        ));
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.SearchLLMObsExperimentation", true);
    let api = AgentObservabilityAPI::with_config(configuration);
    let resp = api.search_llm_obs_experimentation(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.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

/**
 * Search Agent Observability experimentation returns "Partial Content — more results are available. Use `meta.after` as
 * the next `page.cursor`." response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.searchLLMObsExperimentation"] = true;
const apiInstance = new v2.AgentObservabilityApi(configuration);

const params: v2.AgentObservabilityApiSearchLLMObsExperimentationRequest = {
  body: {
    data: {
      attributes: {
        contentPreview: {
          limit: 500,
        },
        filter: {
          includeDeleted: false,
          isDeleted: false,
          query: "my experiment",
          scope: ["experiments"],
          version: undefined,
        },
        include: {
          userData: false,
        },
        page: {
          limit: 100,
        },
      },
      type: "experimentation",
    },
  },
};

apiInstance
  .searchLLMObsExperimentation(params)
  .then((data: v2.LLMObsExperimentationSearchResponse) => {
    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.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>" tsc "example.ts"

Agent Observability 실험 검색

개요

요청

Body Data (required)

응답

코드 사례

Search Agent Observability experimentation

Search Agent Observability experimentation

Instructions

Search Agent Observability experimentation

Instructions

Search Agent Observability experimentation

Instructions

Search Agent Observability experimentation

Instructions

Search Agent Observability experimentation

Instructions

Search Agent Observability experimentation

Instructions

How can I help you today?