Data object for creating an LLM Observability prompt version.
attributes [required]
object
Attributes for creating a new version of an LLM Observability prompt. template is required; all other attributes are optional.
description
string
Optional description of this version.
env_ids
[string]
Optional feature-flag environment UUIDs the service attempts to enable and configure to use this version as their default after creation.
labels
[string]
DEPRECATED: Optional labels to attach to this version. Do not use this attribute for new integrations.
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
Optional user-supplied version identifier for this version.
type [required]
enum
Resource type of an LLM Observability prompt version.
Allowed enum values: prompt-template-versions
{"data":{"attributes":{"template":[{"content":"You are a concise customer support assistant for {{company_name}}.","role":"system"},{"content":"Answer {{customer_name}}'s question: {{question}}","role":"user"}]},"type":"prompt-template-versions"}}
Response containing a specific version of an LLM Observability prompt.
Expand All
Field
Type
Description
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"}}
// Create a new LLM Observability prompt version returns "OK" responsepackagemainimport("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")funcmain(){// there is a valid "prompt" in the systemPromptDataAttributesPromptID:=os.Getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID")body:=datadogV2.LLMObsCreatePromptVersionRequest{Data:datadogV2.LLMObsCreatePromptVersionData{Attributes:datadogV2.LLMObsCreatePromptVersionDataAttributes{Template:datadogV2.LLMObsPromptTemplate{LLMObsPromptChatTemplate:&datadogV2.LLMObsPromptChatTemplate{Items:[]datadogV2.LLMObsPromptChatMessage{{Content:"You are a concise customer support assistant for {{company_name}}.",Role:"system",},{Content:"Answer {{customer_name}}'s question: {{question}}",Role:"user",},}}},},Type:datadogV2.LLMOBSPROMPTVERSIONTYPE_PROMPT_TEMPLATE_VERSIONS,},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.CreateLLMObsPromptVersion",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewLLMObservabilityApi(apiClient)resp,r,err:=api.CreateLLMObsPromptVersion(ctx,PromptDataAttributesPromptID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `LLMObservabilityApi.CreateLLMObsPromptVersion`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `LLMObservabilityApi.CreateLLMObsPromptVersion`:\n%s\n",responseContent)}
// Create a new 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.LLMObsCreatePromptVersionData;importcom.datadog.api.client.v2.model.LLMObsCreatePromptVersionDataAttributes;importcom.datadog.api.client.v2.model.LLMObsCreatePromptVersionRequest;importcom.datadog.api.client.v2.model.LLMObsPromptChatMessage;importcom.datadog.api.client.v2.model.LLMObsPromptChatTemplate;importcom.datadog.api.client.v2.model.LLMObsPromptTemplate;importcom.datadog.api.client.v2.model.LLMObsPromptVersionResponse;importcom.datadog.api.client.v2.model.LLMObsPromptVersionType;importjava.util.Arrays;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.createLLMObsPromptVersion",true);LlmObservabilityApiapiInstance=newLlmObservabilityApi(defaultClient);// there is a valid "prompt" in the systemStringPROMPT_DATA_ATTRIBUTES_PROMPT_ID=System.getenv("PROMPT_DATA_ATTRIBUTES_PROMPT_ID");LLMObsCreatePromptVersionRequestbody=newLLMObsCreatePromptVersionRequest().data(newLLMObsCreatePromptVersionData().attributes(newLLMObsCreatePromptVersionDataAttributes().template(newLLMObsPromptTemplate(newLLMObsPromptChatTemplate(Arrays.asList(newLLMObsPromptChatMessage().content("You are a concise customer support assistant"+" for {{company_name}}.").role("system"),newLLMObsPromptChatMessage().content("Answer {{customer_name}}'s question:"+" {{question}}").role("user")))))).type(LLMObsPromptVersionType.PROMPT_TEMPLATE_VERSIONS));try{LLMObsPromptVersionResponseresult=apiInstance.createLLMObsPromptVersion(PROMPT_DATA_ATTRIBUTES_PROMPT_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling LlmObservabilityApi#createLLMObsPromptVersion");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Create a new LLM Observability prompt version returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.llm_observability_apiimportLLMObservabilityApifromdatadog_api_client.v2.model.llm_obs_create_prompt_version_dataimportLLMObsCreatePromptVersionDatafromdatadog_api_client.v2.model.llm_obs_create_prompt_version_data_attributesimport(LLMObsCreatePromptVersionDataAttributes,)fromdatadog_api_client.v2.model.llm_obs_create_prompt_version_requestimportLLMObsCreatePromptVersionRequestfromdatadog_api_client.v2.model.llm_obs_prompt_chat_messageimportLLMObsPromptChatMessagefromdatadog_api_client.v2.model.llm_obs_prompt_version_typeimportLLMObsPromptVersionType# there is a valid "prompt" in the systemPROMPT_DATA_ATTRIBUTES_PROMPT_ID=environ["PROMPT_DATA_ATTRIBUTES_PROMPT_ID"]body=LLMObsCreatePromptVersionRequest(data=LLMObsCreatePromptVersionData(attributes=LLMObsCreatePromptVersionDataAttributes(template=[LLMObsPromptChatMessage(content="You are a concise customer support assistant for {{company_name}}.",role="system",),LLMObsPromptChatMessage(content="Answer {{customer_name}}'s question: {{question}}",role="user",),],),type=LLMObsPromptVersionType.PROMPT_TEMPLATE_VERSIONS,),)configuration=Configuration()configuration.unstable_operations["create_llm_obs_prompt_version"]=TruewithApiClient(configuration)asapi_client:api_instance=LLMObservabilityApi(api_client)response=api_instance.create_llm_obs_prompt_version(prompt_id=PROMPT_DATA_ATTRIBUTES_PROMPT_ID,body=body)print(response)
# Create a new LLM Observability prompt version returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.create_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"]body=DatadogAPIClient::V2::LLMObsCreatePromptVersionRequest.new({data:DatadogAPIClient::V2::LLMObsCreatePromptVersionData.new({attributes:DatadogAPIClient::V2::LLMObsCreatePromptVersionDataAttributes.new({template:[DatadogAPIClient::V2::LLMObsPromptChatMessage.new({content:"You are a concise customer support assistant for {{company_name}}.",role:"system",}),DatadogAPIClient::V2::LLMObsPromptChatMessage.new({content:"Answer {{customer_name}}'s question: {{question}}",role:"user",}),],}),type:DatadogAPIClient::V2::LLMObsPromptVersionType::PROMPT_TEMPLATE_VERSIONS,}),})papi_instance.create_llm_obs_prompt_version(PROMPT_DATA_ATTRIBUTES_PROMPT_ID,body)
// Create a new LLM Observability prompt version returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_llm_observability::LLMObservabilityAPI;usedatadog_api_client::datadogV2::model::LLMObsCreatePromptVersionData;usedatadog_api_client::datadogV2::model::LLMObsCreatePromptVersionDataAttributes;usedatadog_api_client::datadogV2::model::LLMObsCreatePromptVersionRequest;usedatadog_api_client::datadogV2::model::LLMObsPromptChatMessage;usedatadog_api_client::datadogV2::model::LLMObsPromptTemplate;usedatadog_api_client::datadogV2::model::LLMObsPromptVersionType;#[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();letbody=LLMObsCreatePromptVersionRequest::new(LLMObsCreatePromptVersionData::new(LLMObsCreatePromptVersionDataAttributes::new(LLMObsPromptTemplate::LLMObsPromptChatTemplate(vec![LLMObsPromptChatMessage::new("You are a concise customer support assistant for {{company_name}}.".to_string(),"system".to_string(),),LLMObsPromptChatMessage::new("Answer {{customer_name}}'s question: {{question}}".to_string(),"user".to_string(),),]),),LLMObsPromptVersionType::PROMPT_TEMPLATE_VERSIONS,));letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.CreateLLMObsPromptVersion",true);letapi=LLMObservabilityAPI::with_config(configuration);letresp=api.create_llm_obs_prompt_version(prompt_data_attributes_prompt_id.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
/**
* Create a new LLM Observability prompt version returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.createLLMObsPromptVersion"]=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;constparams: v2.LLMObservabilityApiCreateLLMObsPromptVersionRequest={body:{data:{attributes:{template:[{content:"You are a concise customer support assistant for {{company_name}}.",role:"system",},{content:"Answer {{customer_name}}'s question: {{question}}",role:"user",},],},type:"prompt-template-versions",},},promptId: PROMPT_DATA_ATTRIBUTES_PROMPT_ID,};apiInstance.createLLMObsPromptVersion(params).then((data: v2.LLMObsPromptVersionResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));