Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
PATCH https://api.ap1.datadoghq.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.ap2.datadoghq.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.datadoghq.eu/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.ddog-gov.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.us2.ddog-gov.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.datadoghq.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.us3.datadoghq.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records https://api.us5.datadoghq.com/api/v2/llm-obs/v1/{project_id}/datasets/{dataset_id}/records
Overview Update one or more existing records in an LLM Observability dataset.
Arguments Path Parameters The ID of the LLM Observability project.
The ID of the LLM Observability dataset.
Request Body Data (required) Update records payload.
Expand All
Data object for updating records in an LLM Observability dataset.
Attributes for updating records in an LLM Observability dataset.
List of records to update.
Represents any valid JSON value.
An arbitrary object value with additional properties.
An array of arbitrary values.
An arbitrary object value with additional properties.
Unique identifier of the record to update.
Represents any valid JSON value.
An arbitrary object value with additional properties.
An array of arbitrary values.
An arbitrary object value with additional properties.
Updated metadata associated with the record.
Resource type of LLM Observability dataset records.
Allowed enum values: records
{
"data" : {
"attributes" : {
"records" : [
{
"expected_output" : {
"description" : "undefined" ,
"type" : "undefined"
},
"id" : "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" ,
"input" : {
"description" : "undefined" ,
"type" : "undefined"
},
"metadata" : {}
}
]
},
"type" : "records"
}
} Response OK
Response containing records after a create or update operation.
Expand All
List of affected dataset records.
List of affected dataset records.
Timestamp when the record was created.
Identifier of the dataset this record belongs to.
expected_output [required ]
Represents any valid JSON value.
An arbitrary object value with additional properties.
An array of arbitrary values.
An arbitrary object value with additional properties.
Unique identifier of the record.
Represents any valid JSON value.
An arbitrary object value with additional properties.
An array of arbitrary values.
An arbitrary object value with additional properties.
Arbitrary metadata associated with the record.
Timestamp when the record was last updated.
{
"data" : [
{
"records" : [
{
"created_at" : "2024-01-15T10:30:00Z" ,
"dataset_id" : "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" ,
"expected_output" : {
"description" : "undefined" ,
"type" : "undefined"
},
"id" : "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" ,
"input" : {
"description" : "undefined" ,
"type" : "undefined"
},
"metadata" : {},
"updated_at" : "2024-01-15T10:30:00Z"
}
]
}
]
} 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"
]
} Code Example Copy
## default
#
# Path parameters export project_id = "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" export dataset_id = "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" # Curl command curl -X PATCH "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.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/llm-obs/v1/${project_id}/datasets/${dataset_id}/records " \
-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": {
"records": [
{
"id": "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c"
}
]
},
"type": "records"
}
}
EOF
"""
Update LLM Observability dataset records 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_dataset_record_update_item import LLMObsDatasetRecordUpdateItem
from datadog_api_client.v2.model.llm_obs_dataset_records_update_data_attributes_request import (
LLMObsDatasetRecordsUpdateDataAttributesRequest ,
)
from datadog_api_client.v2.model.llm_obs_dataset_records_update_data_request import (
LLMObsDatasetRecordsUpdateDataRequest ,
)
from datadog_api_client.v2.model.llm_obs_dataset_records_update_request import LLMObsDatasetRecordsUpdateRequest
from datadog_api_client.v2.model.llm_obs_record_type import LLMObsRecordType
body = LLMObsDatasetRecordsUpdateRequest (
data = LLMObsDatasetRecordsUpdateDataRequest (
attributes = LLMObsDatasetRecordsUpdateDataAttributesRequest (
records = [
LLMObsDatasetRecordUpdateItem (
expected_output = None ,
id = "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" ,
input = None ,
),
],
),
type = LLMObsRecordType . RECORDS ,
),
)
configuration = Configuration ()
configuration . unstable_operations [ "update_llm_obs_dataset_records" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = LLMObservabilityApi ( api_client )
response = api_instance . update_llm_obs_dataset_records ( project_id = "project_id" , dataset_id = "dataset_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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Update LLM Observability dataset records returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.update_llm_obs_dataset_records" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: LLMObservabilityAPI . new
body = DatadogAPIClient :: V2 :: LLMObsDatasetRecordsUpdateRequest . new ({
data : DatadogAPIClient :: V2 :: LLMObsDatasetRecordsUpdateDataRequest . new ({
attributes : DatadogAPIClient :: V2 :: LLMObsDatasetRecordsUpdateDataAttributesRequest . new ({
records : [
DatadogAPIClient :: V2 :: LLMObsDatasetRecordUpdateItem . new ({
expected_output : nil ,
id : "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" ,
input : nil ,
}),
] ,
}),
type : DatadogAPIClient :: V2 :: LLMObsRecordType :: RECORDS ,
}),
})
p api_instance . update_llm_obs_dataset_records ( "project_id" , "dataset_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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Update LLM Observability dataset records 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 . LLMObsDatasetRecordsUpdateRequest {
Data : datadogV2 . LLMObsDatasetRecordsUpdateDataRequest {
Attributes : datadogV2 . LLMObsDatasetRecordsUpdateDataAttributesRequest {
Records : [] datadogV2 . LLMObsDatasetRecordUpdateItem {
{
ExpectedOutput : * datadogV2 . NewNullableAnyValue ( nil ),
Id : "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" ,
Input : * datadogV2 . NewNullableAnyValue ( nil ),
},
},
},
Type : datadogV2 . LLMOBSRECORDTYPE_RECORDS ,
},
}
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.UpdateLLMObsDatasetRecords" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewLLMObservabilityApi ( apiClient )
resp , r , err := api . UpdateLLMObsDatasetRecords ( ctx , "project_id" , "dataset_id" , body )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `LLMObservabilityApi.UpdateLLMObsDatasetRecords`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `LLMObservabilityApi.UpdateLLMObsDatasetRecords`:\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 ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Update LLM Observability dataset records 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.LLMObsDatasetRecordUpdateItem ;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsMutationResponse ;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsUpdateDataAttributesRequest ;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsUpdateDataRequest ;
import com.datadog.api.client.v2.model.LLMObsDatasetRecordsUpdateRequest ;
import com.datadog.api.client.v2.model.LLMObsRecordType ;
import java.util.Collections ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.updateLLMObsDatasetRecords" , true );
LlmObservabilityApi apiInstance = new LlmObservabilityApi ( defaultClient );
LLMObsDatasetRecordsUpdateRequest body =
new LLMObsDatasetRecordsUpdateRequest ()
. data (
new LLMObsDatasetRecordsUpdateDataRequest ()
. attributes (
new LLMObsDatasetRecordsUpdateDataAttributesRequest ()
. records (
Collections . singletonList (
new LLMObsDatasetRecordUpdateItem ()
. expectedOutput ( null )
. id ( "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" )
. input ( null ))))
. type ( LLMObsRecordType . RECORDS ));
try {
LLMObsDatasetRecordsMutationResponse result =
apiInstance . updateLLMObsDatasetRecords (
"a33671aa-24fd-4dcd-9b33-a8ec7dde7751" , "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" , body );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling LlmObservabilityApi#updateLLMObsDatasetRecords" );
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 ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Update LLM Observability dataset records returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_llm_observability ::LLMObservabilityAPI ;
use datadog_api_client ::datadogV2 ::model ::LLMObsDatasetRecordUpdateItem ;
use datadog_api_client ::datadogV2 ::model ::LLMObsDatasetRecordsUpdateDataAttributesRequest ;
use datadog_api_client ::datadogV2 ::model ::LLMObsDatasetRecordsUpdateDataRequest ;
use datadog_api_client ::datadogV2 ::model ::LLMObsDatasetRecordsUpdateRequest ;
use datadog_api_client ::datadogV2 ::model ::LLMObsRecordType ;
#[tokio::main]
async fn main () {
let body = LLMObsDatasetRecordsUpdateRequest ::new ( LLMObsDatasetRecordsUpdateDataRequest ::new (
LLMObsDatasetRecordsUpdateDataAttributesRequest ::new ( vec! [
LLMObsDatasetRecordUpdateItem ::new (
"rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" . to_string (),
)
. expected_output ( None )
. input ( None ),
]),
LLMObsRecordType ::RECORDS ,
));
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.UpdateLLMObsDatasetRecords" , true );
let api = LLMObservabilityAPI ::with_config ( configuration );
let resp = api
. update_llm_obs_dataset_records ( "project_id" . to_string (), "dataset_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 us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Update LLM Observability dataset records returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.updateLLMObsDatasetRecords" ] = true ;
const apiInstance = new v2 . LLMObservabilityApi ( configuration );
const params : v2.LLMObservabilityApiUpdateLLMObsDatasetRecordsRequest = {
body : {
data : {
attributes : {
records : [
{
expectedOutput : undefined ,
id : "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" ,
input : undefined ,
},
],
},
type : "records" ,
},
},
projectId : "project_id" ,
datasetId : "dataset_id" ,
};
apiInstance
. updateLLMObsDatasetRecords ( params )
. then (( data : v2.LLMObsDatasetRecordsMutationResponse ) => {
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 ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"