Update the description, the feature-flag environments, or both, for a specific version of an LLM Observability prompt.
This endpoint requires
all
of the following permissions:
llm_observability_read
llm_observability_write
feature_flag_config_read
feature_flag_config_write
feature_flag_environment_config_read
Argumentos
Parámetros de ruta
Nombre
Tipo
Descripción
prompt_id [required]
string
The customer-provided identifier of the LLM Observability prompt.
version [required]
integer
The version number of the LLM Observability prompt.
Data object for updating an LLM Observability prompt version.
attributes [required]
object
Attributes for updating an LLM Observability prompt version. At least one of description, labels, or env_ids must be provided; all three attributes are optional individually.
description
string
Optional new description for this version.
env_ids
[string]
Optional feature-flag environment UUIDs the service attempts to enable and configure to use this version as their default.
labels
[string]
DEPRECATED: Optional new labels for this version. Do not use this attribute for new integrations.
type [required]
enum
Resource type of an LLM Observability prompt version.
Allowed enum values: prompt-template-versions
{"data":{"attributes":{"description":"Give concise answers and cite relevant help-center articles."},"type":"prompt-template-versions"}}
Response containing a specific version of an LLM Observability prompt.
Expand All
Campo
Tipo
Descripción
data [required]
object
Data object for a specific version of an LLM Observability prompt.
attributes [required]
object
Attributes of a specific version of an LLM Observability prompt.
author
string
UUID of the user who authored this version.
created_at
date-time
Timestamp stored on this prompt version.
datasets
[object]
Datasets observed in runs associated with this prompt version.
id [required]
string
Unique identifier of the dataset.
name
string
Name of the dataset.
description
string
Description of this version.
labels
[string]
DEPRECATED: Labels attached to this version (for example development, staging, production).
last_seen_at
date-time
Timestamp of the most recent observed run of this prompt version.
ml_app
string
The ML application this prompt is associated with.
ml_apps
[string]
ML applications observed running this prompt version.
prompt_id [required]
string
Customer-provided identifier of the parent prompt.
prompt_uuid [required]
string
Unique identifier of the parent prompt.
tags
[string]
Tags observed on runs of this prompt version.
template [required]
<oneOf>
A text template or a list of chat messages.
Object 1
string
A text prompt template.
Object 2
[object]
A chat prompt template.
content [required]
string
Content of the message.
role [required]
string
Role of the message (for example system, user, or assistant).
user_version
string
User-supplied identifier for this version.
version [required]
int64
Sequential version number.
version_created_at
date-time
Timestamp when this version was created.
id [required]
string
Unique identifier of the prompt version.
type [required]
enum
Resource type of an LLM Observability prompt version.
Allowed enum values: prompt-template-versions
{"data":{"attributes":{"author":"3b12f1df-14fd-4e12-bd6f-4a2f5c8b3d1e","created_at":"2025-02-01T14:30:00Z","description":"Give concise answers and cite relevant help-center articles.","prompt_id":"customer-support-assistant","prompt_uuid":"4a1a28ff-8a25-5f0f-946f-f48264d772eb","template":[{"content":"You are a helpful customer support assistant for {{company_name}}.","role":"system"},{"content":"Help {{customer_name}} with this question: {{question}}","role":"user"}],"version":2,"version_created_at":"2025-02-01T14:30:00Z"},"id":"d83ab666-61cc-5545-a83b-2424bb85467b","type":"prompt-template-versions"}}
// Update a specific LLM Observability prompt version returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""strconv""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){// there is a valid "prompt" in the systemPromptDataAttributesPromptID:=os.Getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID")// there is a valid "prompt_version" in the systemPromptVersionDataAttributesVersion,_:=strconv.ParseInt(os.Getenv("PROMPT_VERSION_DATA_ATTRIBUTES_VERSION"),10,64)body:=datadogV2.LLMObsUpdatePromptVersionRequest{Data:datadogV2.LLMObsUpdatePromptVersionData{Attributes:datadogV2.LLMObsUpdatePromptVersionDataAttributes{Description:datadog.PtrString("Give concise answers and cite relevant help-center articles."),},Type:datadogV2.LLMOBSPROMPTVERSIONTYPE_PROMPT_TEMPLATE_VERSIONS,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.UpdateLLMObsPromptVersion",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewLLMObservabilityApi(apiClient)resp,r,err:=api.UpdateLLMObsPromptVersion(ctx,PromptDataAttributesPromptID,PromptVersionDataAttributesVersion,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `LLMObservabilityApi.UpdateLLMObsPromptVersion`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `LLMObservabilityApi.UpdateLLMObsPromptVersion`:\n%s\n",responseContent)}
// Update a specific LLM Observability prompt version returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.LlmObservabilityApi;importcom.datadog.api.client.v2.model.LLMObsPromptVersionResponse;importcom.datadog.api.client.v2.model.LLMObsPromptVersionType;importcom.datadog.api.client.v2.model.LLMObsUpdatePromptVersionData;importcom.datadog.api.client.v2.model.LLMObsUpdatePromptVersionDataAttributes;importcom.datadog.api.client.v2.model.LLMObsUpdatePromptVersionRequest;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.updateLLMObsPromptVersion",true);LlmObservabilityApiapiInstance=newLlmObservabilityApi(defaultClient);// there is a valid "prompt" in the systemStringPROMPT_DATA_ATTRIBUTES_PROMPT_ID=System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");// there is a valid "prompt_version" in the systemLongPROMPT_VERSION_DATA_ATTRIBUTES_VERSION=Long.parseLong(System.getenv("PROMPT_VERSION_DATA_ATTRIBUTES_VERSION"));LLMObsUpdatePromptVersionRequestbody=newLLMObsUpdatePromptVersionRequest().data(newLLMObsUpdatePromptVersionData().attributes(newLLMObsUpdatePromptVersionDataAttributes().description("Give concise answers and cite relevant help-center articles.")).type(LLMObsPromptVersionType.PROMPT_TEMPLATE_VERSIONS));try{LLMObsPromptVersionResponseresult=apiInstance.updateLLMObsPromptVersion(PROMPT_DATA_ATTRIBUTES_PROMPT_ID,PROMPT_VERSION_DATA_ATTRIBUTES_VERSION,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling LlmObservabilityApi#updateLLMObsPromptVersion");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update a specific LLM Observability prompt version returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.llm_observability_apiimportLLMObservabilityApifromdatadog_api_client.v2.model.llm_obs_prompt_version_typeimportLLMObsPromptVersionTypefromdatadog_api_client.v2.model.llm_obs_update_prompt_version_dataimportLLMObsUpdatePromptVersionDatafromdatadog_api_client.v2.model.llm_obs_update_prompt_version_data_attributesimport(LLMObsUpdatePromptVersionDataAttributes,)fromdatadog_api_client.v2.model.llm_obs_update_prompt_version_requestimportLLMObsUpdatePromptVersionRequest# there is a valid "prompt" in the systemPROMPT_DATA_ATTRIBUTES_PROMPT_ID=environ["PROMPT_DATA_ATTRIBUTES_PROMPT_ID"]# there is a valid "prompt_version" in the systemPROMPT_VERSION_DATA_ATTRIBUTES_VERSION=environ["PROMPT_VERSION_DATA_ATTRIBUTES_VERSION"]body=LLMObsUpdatePromptVersionRequest(data=LLMObsUpdatePromptVersionData(attributes=LLMObsUpdatePromptVersionDataAttributes(description="Give concise answers and cite relevant help-center articles.",),type=LLMObsPromptVersionType.PROMPT_TEMPLATE_VERSIONS,),)configuration=Configuration()configuration.unstable_operations["update_llm_obs_prompt_version"]=TruewithApiClient(configuration)asapi_client:api_instance=LLMObservabilityApi(api_client)response=api_instance.update_llm_obs_prompt_version(prompt_id=PROMPT_DATA_ATTRIBUTES_PROMPT_ID,version=int(PROMPT_VERSION_DATA_ATTRIBUTES_VERSION),body=body)print(response)
# Update a specific LLM Observability prompt version returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.update_llm_obs_prompt_version".to_sym]=trueendapi_instance=DatadogAPIClient::V2::LLMObservabilityAPI.new# there is a valid "prompt" in the systemPROMPT_DATA_ATTRIBUTES_PROMPT_ID=ENV["PROMPT_DATA_ATTRIBUTES_PROMPT_ID"]# there is a valid "prompt_version" in the systemPROMPT_VERSION_DATA_ATTRIBUTES_VERSION=ENV["PROMPT_VERSION_DATA_ATTRIBUTES_VERSION"]body=DatadogAPIClient::V2::LLMObsUpdatePromptVersionRequest.new({data:DatadogAPIClient::V2::LLMObsUpdatePromptVersionData.new({attributes:DatadogAPIClient::V2::LLMObsUpdatePromptVersionDataAttributes.new({description:"Give concise answers and cite relevant help-center articles.",}),type:DatadogAPIClient::V2::LLMObsPromptVersionType::PROMPT_TEMPLATE_VERSIONS,}),})papi_instance.update_llm_obs_prompt_version(PROMPT_DATA_ATTRIBUTES_PROMPT_ID,PROMPT_VERSION_DATA_ATTRIBUTES_VERSION.to_i,body)
// Update a specific LLM Observability prompt version returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_llm_observability::LLMObservabilityAPI;usedatadog_api_client::datadogV2::model::LLMObsPromptVersionType;usedatadog_api_client::datadogV2::model::LLMObsUpdatePromptVersionData;usedatadog_api_client::datadogV2::model::LLMObsUpdatePromptVersionDataAttributes;usedatadog_api_client::datadogV2::model::LLMObsUpdatePromptVersionRequest;#[tokio::main]asyncfnmain(){// there is a valid "prompt" in the system
letprompt_data_attributes_prompt_id=std::env::var("PROMPT_DATA_ATTRIBUTES_PROMPT_ID").unwrap();// there is a valid "prompt_version" in the system
letprompt_version_data_attributes_version: i64=std::env::var("PROMPT_VERSION_DATA_ATTRIBUTES_VERSION").unwrap().parse().unwrap();letbody=LLMObsUpdatePromptVersionRequest::new(LLMObsUpdatePromptVersionData::new(LLMObsUpdatePromptVersionDataAttributes::new().description("Give concise answers and cite relevant help-center articles.".to_string(),),LLMObsPromptVersionType::PROMPT_TEMPLATE_VERSIONS,));letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.UpdateLLMObsPromptVersion",true);letapi=LLMObservabilityAPI::with_config(configuration);letresp=api.update_llm_obs_prompt_version(prompt_data_attributes_prompt_id.clone(),prompt_version_data_attributes_version.clone(),body,).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
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
/**
* Update a specific LLM Observability prompt version returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.updateLLMObsPromptVersion"]=true;constapiInstance=newv2.LLMObservabilityApi(configuration);// there is a valid "prompt" in the system
constPROMPT_DATA_ATTRIBUTES_PROMPT_ID=process.env.PROMPT_DATA_ATTRIBUTES_PROMPT_IDasstring;// there is a valid "prompt_version" in the system
constPROMPT_VERSION_DATA_ATTRIBUTES_VERSION=parseInt(process.env.PROMPT_VERSION_DATA_ATTRIBUTES_VERSIONasstring);constparams: v2.LLMObservabilityApiUpdateLLMObsPromptVersionRequest={body:{data:{attributes:{description:"Give concise answers and cite relevant help-center articles.",},type:"prompt-template-versions",},},promptId: PROMPT_DATA_ATTRIBUTES_PROMPT_ID,version: PROMPT_VERSION_DATA_ATTRIBUTES_VERSION,};apiInstance.updateLLMObsPromptVersion(params).then((data: v2.LLMObsPromptVersionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));