Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
PUT https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.ap2.datadoghq.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.datadoghq.eu/api/v2/llm-obs/v1/topic-discovery-configs https://api.ddog-gov.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.us2.ddog-gov.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.uk1.datadoghq.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.datadoghq.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.us3.datadoghq.com/api/v2/llm-obs/v1/topic-discovery-configs https://api.us5.datadoghq.com/api/v2/llm-obs/v1/topic-discovery-configs
Overview Create a new patterns configuration, or update an existing one when a configuration ID is provided.
Request Body Data (required) Patterns configuration payload.
Expand All
Data object for creating or updating an LLM Observability patterns configuration.
Attributes for creating or updating an LLM Observability patterns configuration.
Integration account ID for a bring-your-own-model configuration.
The ID of an existing configuration to update. If omitted, a new configuration is created.
Query that selects the spans the patterns run analyzes.
hierarchy_depth [required ]
Depth of the topic hierarchy to generate.
Integration provider for a bring-your-own-model configuration.
Model name for a bring-your-own-model configuration.
Name of the configuration.
Maximum number of records to process for the run.
sampling_ratio [required ]
Fraction of matching spans to sample for the run.
Scope of the configuration.
Template used to guide topic generation.
Resource type of an LLM Observability patterns configuration.
Allowed enum values: topic_discovery_configs
{
"data" : {
"attributes" : {
"account_id" : "1000000001" ,
"config_id" : "a7c8d9e0-1234-5678-9abc-def012345678" ,
"evp_query" : "@ml_app:support-bot" ,
"hierarchy_depth" : 2 ,
"integration_provider" : "openai" ,
"model_name" : "gpt-4o" ,
"name" : "Support chatbot topics" ,
"num_records" : 1000 ,
"sampling_ratio" : 0.1 ,
"scope" : "" ,
"template" : ""
},
"type" : "topic_discovery_configs"
}
} Response OK
Response containing a single LLM Observability patterns configuration.
Expand All
Data object of an LLM Observability patterns configuration.
Attributes of an LLM Observability patterns configuration.
Integration account ID for a bring-your-own-model configuration.
Timestamp when the configuration was created.
Query that selects the spans the patterns run analyzes.
hierarchy_depth [required ]
Depth of the topic hierarchy to generate.
Integration provider for a bring-your-own-model configuration.
Model name for a bring-your-own-model configuration.
Name of the configuration.
Maximum number of records to process for the run.
sampling_ratio [required ]
Fraction of matching spans to sample for the run.
Scope of the configuration.
Template used to guide topic generation.
Timestamp when the configuration was last updated.
Unique identifier of the configuration.
Resource type of an LLM Observability patterns configuration.
Allowed enum values: topic_discovery_configs
{
"data" : {
"attributes" : {
"account_id" : "1000000001" ,
"created_at" : "2024-01-15T10:30:00Z" ,
"evp_query" : "@ml_app:support-bot" ,
"hierarchy_depth" : 2 ,
"integration_provider" : "openai" ,
"model_name" : "gpt-4o" ,
"name" : "Support chatbot topics" ,
"num_records" : 1000 ,
"sampling_ratio" : 0.1 ,
"scope" : "" ,
"template" : "" ,
"updated_at" : "2024-01-15T10:30:00Z"
},
"id" : "a7c8d9e0-1234-5678-9abc-def012345678" ,
"type" : "topic_discovery_configs"
}
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Internal Server Error
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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"
}
]
} Code Example Copy
## default
#
# Curl command curl -X PUT "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/topic-discovery-configs " \
-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": {
"evp_query": "@ml_app:support-bot",
"hierarchy_depth": 2,
"name": "Support chatbot topics",
"num_records": 1000,
"sampling_ratio": 0.1
},
"type": "topic_discovery_configs"
}
}
EOF
"""
Create or update a patterns configuration returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.llm_observability_api import LLMObservabilityApi
from datadog_api_client.v2.model.llm_obs_patterns_config_type import LLMObsPatternsConfigType
from datadog_api_client.v2.model.llm_obs_patterns_config_upsert_request import LLMObsPatternsConfigUpsertRequest
from datadog_api_client.v2.model.llm_obs_patterns_config_upsert_request_attributes import (
LLMObsPatternsConfigUpsertRequestAttributes ,
)
from datadog_api_client.v2.model.llm_obs_patterns_config_upsert_request_data import (
LLMObsPatternsConfigUpsertRequestData ,
)
body = LLMObsPatternsConfigUpsertRequest (
data = LLMObsPatternsConfigUpsertRequestData (
attributes = LLMObsPatternsConfigUpsertRequestAttributes (
account_id = "1000000001" ,
config_id = "a7c8d9e0-1234-5678-9abc-def012345678" ,
evp_query = "@ml_app:support-bot" ,
hierarchy_depth = 2 ,
integration_provider = "openai" ,
model_name = "gpt-4o" ,
name = "Support chatbot topics" ,
num_records = 1000 ,
sampling_ratio = 0.1 ,
scope = "" ,
template = "" ,
),
type = LLMObsPatternsConfigType . TOPIC_DISCOVERY_CONFIGS ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "upsert_llm_obs_patterns_config" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = LLMObservabilityApi ( api_client )
response = api_instance . upsert_llm_obs_patterns_config ( 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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Create or update a patterns configuration returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.upsert_llm_obs_patterns_config" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: LLMObservabilityAPI . new
body = DatadogAPIClient :: V2 :: LLMObsPatternsConfigUpsertRequest . new ({
data : DatadogAPIClient :: V2 :: LLMObsPatternsConfigUpsertRequestData . new ({
attributes : DatadogAPIClient :: V2 :: LLMObsPatternsConfigUpsertRequestAttributes . new ({
account_id : "1000000001" ,
config_id : "a7c8d9e0-1234-5678-9abc-def012345678" ,
evp_query : "@ml_app:support-bot" ,
hierarchy_depth : 2 ,
integration_provider : "openai" ,
model_name : "gpt-4o" ,
name : "Support chatbot topics" ,
num_records : 1000 ,
sampling_ratio : 0 . 1 ,
scope : "" ,
template : "" ,
}),
type : DatadogAPIClient :: V2 :: LLMObsPatternsConfigType :: TOPIC_DISCOVERY_CONFIGS ,
}),
})
p api_instance . upsert_llm_obs_patterns_config ( 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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Create or update a patterns configuration returns "OK" 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 . LLMObsPatternsConfigUpsertRequest {
Data : datadogV2 . LLMObsPatternsConfigUpsertRequestData {
Attributes : datadogV2 . LLMObsPatternsConfigUpsertRequestAttributes {
AccountId : datadog . PtrString ( "1000000001" ),
ConfigId : datadog . PtrString ( "a7c8d9e0-1234-5678-9abc-def012345678" ),
EvpQuery : "@ml_app:support-bot" ,
HierarchyDepth : 2 ,
IntegrationProvider : datadog . PtrString ( "openai" ),
ModelName : datadog . PtrString ( "gpt-4o" ),
Name : "Support chatbot topics" ,
NumRecords : 1000 ,
SamplingRatio : 0.1 ,
Scope : datadog . PtrString ( "" ),
Template : datadog . PtrString ( "" ),
},
Type : datadogV2 . LLMOBSPATTERNSCONFIGTYPE_TOPIC_DISCOVERY_CONFIGS ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.UpsertLLMObsPatternsConfig" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewLLMObservabilityApi ( apiClient )
resp , r , err := api . UpsertLLMObsPatternsConfig ( ctx , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `LLMObservabilityApi.UpsertLLMObsPatternsConfig`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `LLMObservabilityApi.UpsertLLMObsPatternsConfig`:\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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Create or update a patterns configuration returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.LlmObservabilityApi ;
import com.datadog.api.client.v2.model.LLMObsPatternsConfigResponse ;
import com.datadog.api.client.v2.model.LLMObsPatternsConfigType ;
import com.datadog.api.client.v2.model.LLMObsPatternsConfigUpsertRequest ;
import com.datadog.api.client.v2.model.LLMObsPatternsConfigUpsertRequestAttributes ;
import com.datadog.api.client.v2.model.LLMObsPatternsConfigUpsertRequestData ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.upsertLLMObsPatternsConfig" , true );
LlmObservabilityApi apiInstance = new LlmObservabilityApi ( defaultClient );
LLMObsPatternsConfigUpsertRequest body =
new LLMObsPatternsConfigUpsertRequest ()
. data (
new LLMObsPatternsConfigUpsertRequestData ()
. attributes (
new LLMObsPatternsConfigUpsertRequestAttributes ()
. accountId ( "1000000001" )
. configId ( "a7c8d9e0-1234-5678-9abc-def012345678" )
. evpQuery ( "@ml_app:support-bot" )
. hierarchyDepth ( 2 )
. integrationProvider ( "openai" )
. modelName ( "gpt-4o" )
. name ( "Support chatbot topics" )
. numRecords ( 1000 )
. samplingRatio ( 0 . 1 )
. scope ( "" )
. template ( "" ))
. type ( LLMObsPatternsConfigType . TOPIC_DISCOVERY_CONFIGS ));
try {
LLMObsPatternsConfigResponse result = apiInstance . upsertLLMObsPatternsConfig ( body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling LlmObservabilityApi#upsertLLMObsPatternsConfig" );
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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Create or update a patterns configuration returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_llm_observability ::LLMObservabilityAPI ;
use datadog_api_client ::datadogV2 ::model ::LLMObsPatternsConfigType ;
use datadog_api_client ::datadogV2 ::model ::LLMObsPatternsConfigUpsertRequest ;
use datadog_api_client ::datadogV2 ::model ::LLMObsPatternsConfigUpsertRequestAttributes ;
use datadog_api_client ::datadogV2 ::model ::LLMObsPatternsConfigUpsertRequestData ;
#[tokio::main]
async fn main () {
let body = LLMObsPatternsConfigUpsertRequest ::new ( LLMObsPatternsConfigUpsertRequestData ::new (
LLMObsPatternsConfigUpsertRequestAttributes ::new (
"@ml_app:support-bot" . to_string (),
2 ,
"Support chatbot topics" . to_string (),
1000 ,
0.1 ,
)
. account_id ( "1000000001" . to_string ())
. config_id ( "a7c8d9e0-1234-5678-9abc-def012345678" . to_string ())
. integration_provider ( "openai" . to_string ())
. model_name ( "gpt-4o" . to_string ())
. scope ( "" . to_string ())
. template ( "" . to_string ()),
LLMObsPatternsConfigType ::TOPIC_DISCOVERY_CONFIGS ,
));
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.UpsertLLMObsPatternsConfig" , true );
let api = LLMObservabilityAPI ::with_config ( configuration );
let resp = api . upsert_llm_obs_patterns_config ( 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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Create or update a patterns configuration returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.upsertLLMObsPatternsConfig" ] = true ;
const apiInstance = new v2 . LLMObservabilityApi ( configuration );
const params : v2.LLMObservabilityApiUpsertLLMObsPatternsConfigRequest = {
body : {
data : {
attributes : {
accountId : "1000000001" ,
configId : "a7c8d9e0-1234-5678-9abc-def012345678" ,
evpQuery : "@ml_app:support-bot" ,
hierarchyDepth : 2 ,
integrationProvider : "openai" ,
modelName : "gpt-4o" ,
name : "Support chatbot topics" ,
numRecords : 1000 ,
samplingRatio : 0.1 ,
scope : "" ,
template : "" ,
},
type : "topic_discovery_configs" ,
},
},
};
apiInstance
. upsertLLMObsPatternsConfig ( params )
. then (( data : v2.LLMObsPatternsConfigResponse ) => {
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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"