Class: DatadogAPIClient::V2::LLMObsCreatePromptDataAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb

Overview

Attributes for creating an Agent Observability prompt and its first version. prompt_id and template are required; all other attributes are optional. If config is omitted, the first version stores an empty object. Configuration authoring must be enabled for your organization to supply config. Otherwise, supplying it, including an empty object, returns HTTP 403.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



50
51
52
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 50

def additional_properties
  @additional_properties
end

#config ⇒ Object

Versioned prompt configuration is in Preview. To request access, contact Datadog Support or your Customer Success Manager. Customer-owned configuration delivered with a prompt version. Datadog stores and returns the object without interpolating it, validating provider-specific keys, or applying it to model calls. Do not include secrets.



25
26
27
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 25

def config
  @config
end

#description ⇒ Object

Optional description of the prompt.



28
29
30
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 28

def description
  @description
end

#env_ids ⇒ Object

Optional feature-flag environment UUIDs the service attempts to enable and configure to use the first version as their default after creation.



31
32
33
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 31

def env_ids
  @env_ids
end

#labels ⇒ Object

Optional labels to attach to the first version. Do not use this attribute for new integrations.



34
35
36
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 34

def labels
  @labels
end

#prompt_id ⇒ Object

Customer-provided identifier for the new prompt.



37
38
39
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 37

def prompt_id
  @prompt_id
end

#template ⇒ Object

A text template, a list of chat messages, or an authored chat object. Text can include an exact prompt version with {{>prompt-id version=N}}; other text, including {{>...}} sequences without a version, remains literal. Use an authored chat object when including prompts as chat messages. Preview: Prompt composition is available in Preview. To request access, contact Datadog Support or your Customer Success Manager. Without access, inline references remain literal text and structured includes are unsupported. Previously compiled prompt versions remain available for execution.



42
43
44
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 42

def template
  @template
end

#title ⇒ Object

Optional title of the prompt.



45
46
47
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 45

def title
  @title
end

#user_version ⇒ Object

Optional user-supplied version identifier for the first version.



48
49
50
# File 'lib/datadog_api_client/v2/models/llm_obs_create_prompt_data_attributes.rb', line 48

def user_version
  @user_version
end