Add display_block interaction type to LLM Obs annotation queues (#1594)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -6,17 +6,20 @@ use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsDataA
 use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsDataRequest;
 use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsRequest;
 use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsType;
-use datadog_api_client::datadogV2::model::LLMObsInteractionType;
+use datadog_api_client::datadogV2::model::LLMObsTraceInteractionItem;
+use datadog_api_client::datadogV2::model::LLMObsTraceInteractionType;
 
 #[tokio::main]
 async fn main() {
     let body = LLMObsAnnotationQueueInteractionsRequest::new(
         LLMObsAnnotationQueueInteractionsDataRequest::new(
             LLMObsAnnotationQueueInteractionsDataAttributesRequest::new(vec![
-                LLMObsAnnotationQueueInteractionItem::new(
-                    "trace-abc-123".to_string(),
-                    LLMObsInteractionType::TRACE,
-                ),
+                LLMObsAnnotationQueueInteractionItem::LLMObsTraceInteractionItem(Box::new(
+                    LLMObsTraceInteractionItem::new(
+                        "trace-abc-123".to_string(),
+                        LLMObsTraceInteractionType::TRACE,
+                    ),
+                )),
             ]),
             LLMObsAnnotationQueueInteractionsType::INTERACTIONS,
         ),

examples/v2_llm-observability_CreateLLMObsAnnotationQueueInteractions.rs

@@ -0,0 +1,43 @@
+// Add a display_block interaction returns "Created" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_llm_observability::LLMObservabilityAPI;
+use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionItem;
+use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsDataAttributesRequest;
+use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsDataRequest;
+use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsRequest;
+use datadog_api_client::datadogV2::model::LLMObsAnnotationQueueInteractionsType;
+use datadog_api_client::datadogV2::model::LLMObsContentBlock;
+use datadog_api_client::datadogV2::model::LLMObsContentBlockType;
+use datadog_api_client::datadogV2::model::LLMObsDisplayBlockInteractionItem;
+use datadog_api_client::datadogV2::model::LLMObsDisplayBlockInteractionType;
+use serde_json::Value;
+
+#[tokio::main]
+async fn main() {
+    let body = LLMObsAnnotationQueueInteractionsRequest::new(
+        LLMObsAnnotationQueueInteractionsDataRequest::new(
+            LLMObsAnnotationQueueInteractionsDataAttributesRequest::new(vec![
+                LLMObsAnnotationQueueInteractionItem::LLMObsDisplayBlockInteractionItem(Box::new(
+                    LLMObsDisplayBlockInteractionItem::new(
+                        vec![LLMObsContentBlock::new(LLMObsContentBlockType::MARKDOWN)
+                            .content(Value::from("## Triage Instructions"))],
+                        LLMObsDisplayBlockInteractionType::DISPLAY_BLOCK,
+                    ),
+                )),
+            ]),
+            LLMObsAnnotationQueueInteractionsType::INTERACTIONS,
+        ),
+    );
+    let mut configuration = datadog::Configuration::new();
+    configuration
+        .set_unstable_operation_enabled("v2.CreateLLMObsAnnotationQueueInteractions", true);
+    let api = LLMObservabilityAPI::with_config(configuration);
+    let resp = api
+        .create_llm_obs_annotation_queue_interactions("queue_id".to_string(), body)
+        .await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

examples/v2_llm-observability_CreateLLMObsAnnotationQueueInteractions_2021594537.rs

@@ -689,8 +689,16 @@ impl LLMObservabilityAPI {
         }
     }
 
-    /// Add one or more interactions (traces or sessions) to an annotation queue.
-    /// At least one interaction must be provided.
+    /// Add one or more interactions to an annotation queue. At least one
+    /// interaction must be provided. Each interaction has a `type`:
+    ///
+    /// - `trace`, `experiment_trace`, `session`: `content_id` references the
+    ///   upstream entity; the server fetches the actual content.
+    /// - `display_block`: omit `content_id` and provide the rendered content
+    ///   in `display_block`. The server generates `content_id` as a
+    ///   deterministic hash of the block list.
+    ///
+    /// Items of different types can be mixed in a single request.
     pub async fn create_llm_obs_annotation_queue_interactions(
         &self,
         queue_id: String,
@@ -716,8 +724,16 @@ impl LLMObservabilityAPI {
         }
     }
 
-    /// Add one or more interactions (traces or sessions) to an annotation queue.
-    /// At least one interaction must be provided.
+    /// Add one or more interactions to an annotation queue. At least one
+    /// interaction must be provided. Each interaction has a `type`:
+    ///
+    /// - `trace`, `experiment_trace`, `session`: `content_id` references the
+    ///   upstream entity; the server fetches the actual content.
+    /// - `display_block`: omit `content_id` and provide the rendered content
+    ///   in `display_block`. The server generates `content_id` as a
+    ///   deterministic hash of the block list.
+    ///
+    /// Items of different types can be mixed in a single request.
     pub async fn create_llm_obs_annotation_queue_interactions_with_http_info(
         &self,
         queue_id: String,

src/datadogV2/api/api_llm_observability.rs

@@ -4730,12 +4730,28 @@ pub mod model_llm_obs_annotated_interactions_data_response;
 pub use self::model_llm_obs_annotated_interactions_data_response::LLMObsAnnotatedInteractionsDataResponse;
 pub mod model_llm_obs_annotated_interactions_data_attributes_response;
 pub use self::model_llm_obs_annotated_interactions_data_attributes_response::LLMObsAnnotatedInteractionsDataAttributesResponse;
-pub mod model_llm_obs_annotated_interaction_item;
-pub use self::model_llm_obs_annotated_interaction_item::LLMObsAnnotatedInteractionItem;
+pub mod model_llm_obs_trace_annotated_interaction_item;
+pub use self::model_llm_obs_trace_annotated_interaction_item::LLMObsTraceAnnotatedInteractionItem;
 pub mod model_llm_obs_annotation_item;
 pub use self::model_llm_obs_annotation_item::LLMObsAnnotationItem;
-pub mod model_llm_obs_interaction_type;
-pub use self::model_llm_obs_interaction_type::LLMObsInteractionType;
+pub mod model_llm_obs_trace_interaction_type;
+pub use self::model_llm_obs_trace_interaction_type::LLMObsTraceInteractionType;
+pub mod model_llm_obs_display_block_annotated_interaction_item;
+pub use self::model_llm_obs_display_block_annotated_interaction_item::LLMObsDisplayBlockAnnotatedInteractionItem;
+pub mod model_llm_obs_content_block;
+pub use self::model_llm_obs_content_block::LLMObsContentBlock;
+pub mod model_llm_obs_content_block_llm_obs_trace_interaction_type;
+pub use self::model_llm_obs_content_block_llm_obs_trace_interaction_type::LLMObsContentBlockLLMObsTraceInteractionType;
+pub mod model_llm_obs_content_block_header_level;
+pub use self::model_llm_obs_content_block_header_level::LLMObsContentBlockHeaderLevel;
+pub mod model_llm_obs_content_block_time_frame;
+pub use self::model_llm_obs_content_block_time_frame::LLMObsContentBlockTimeFrame;
+pub mod model_llm_obs_content_block_type;
+pub use self::model_llm_obs_content_block_type::LLMObsContentBlockType;
+pub mod model_llm_obs_display_block_interaction_type;
+pub use self::model_llm_obs_display_block_interaction_type::LLMObsDisplayBlockInteractionType;
+pub mod model_llm_obs_annotated_interaction_item;
+pub use self::model_llm_obs_annotated_interaction_item::LLMObsAnnotatedInteractionItem;
 pub mod model_llm_obs_annotated_interactions_type;
 pub use self::model_llm_obs_annotated_interactions_type::LLMObsAnnotatedInteractionsType;
 pub mod model_llm_obs_annotation_queue_interactions_request;
@@ -4744,6 +4760,10 @@ pub mod model_llm_obs_annotation_queue_interactions_data_request;
 pub use self::model_llm_obs_annotation_queue_interactions_data_request::LLMObsAnnotationQueueInteractionsDataRequest;
 pub mod model_llm_obs_annotation_queue_interactions_data_attributes_request;
 pub use self::model_llm_obs_annotation_queue_interactions_data_attributes_request::LLMObsAnnotationQueueInteractionsDataAttributesRequest;
+pub mod model_llm_obs_trace_interaction_item;
+pub use self::model_llm_obs_trace_interaction_item::LLMObsTraceInteractionItem;
+pub mod model_llm_obs_display_block_interaction_item;
+pub use self::model_llm_obs_display_block_interaction_item::LLMObsDisplayBlockInteractionItem;
 pub mod model_llm_obs_annotation_queue_interaction_item;
 pub use self::model_llm_obs_annotation_queue_interaction_item::LLMObsAnnotationQueueInteractionItem;
 pub mod model_llm_obs_annotation_queue_interactions_type;
@@ -4754,6 +4774,10 @@ pub mod model_llm_obs_annotation_queue_interactions_data_response;
 pub use self::model_llm_obs_annotation_queue_interactions_data_response::LLMObsAnnotationQueueInteractionsDataResponse;
 pub mod model_llm_obs_annotation_queue_interactions_data_attributes_response;
 pub use self::model_llm_obs_annotation_queue_interactions_data_attributes_response::LLMObsAnnotationQueueInteractionsDataAttributesResponse;
+pub mod model_llm_obs_trace_interaction_response_item;
+pub use self::model_llm_obs_trace_interaction_response_item::LLMObsTraceInteractionResponseItem;
+pub mod model_llm_obs_display_block_interaction_response_item;
+pub use self::model_llm_obs_display_block_interaction_response_item::LLMObsDisplayBlockInteractionResponseItem;
 pub mod model_llm_obs_annotation_queue_interaction_response_item;
 pub use self::model_llm_obs_annotation_queue_interaction_response_item::LLMObsAnnotationQueueInteractionResponseItem;
 pub mod model_llm_obs_delete_annotation_queue_interactions_request;

src/datadogV2/model/mod.rs

@@ -1,138 +1,49 @@
 // Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2019-Present Datadog, Inc.
-use serde::de::{Error, MapAccess, Visitor};
 use serde::{Deserialize, Deserializer, Serialize};
-use serde_with::skip_serializing_none;
-use std::fmt::{self, Formatter};
 
 /// An interaction with its associated annotations.
 #[non_exhaustive]
-#[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
-pub struct LLMObsAnnotatedInteractionItem {
-    /// List of annotations for this interaction.
-    #[serde(rename = "annotations")]
-    pub annotations: Vec<crate::datadogV2::model::LLMObsAnnotationItem>,
-    /// Identifier of the content (trace ID or session ID) for this interaction.
-    #[serde(rename = "content_id")]
-    pub content_id: String,
-    /// Unique identifier of the interaction.
-    #[serde(rename = "id")]
-    pub id: String,
-    /// Type of interaction in an annotation queue.
-    #[serde(rename = "type")]
-    pub type_: crate::datadogV2::model::LLMObsInteractionType,
-    #[serde(flatten)]
-    pub additional_properties: std::collections::BTreeMap<String, serde_json::Value>,
-    #[serde(skip)]
-    #[serde(default)]
-    pub(crate) _unparsed: bool,
-}
-
-impl LLMObsAnnotatedInteractionItem {
-    pub fn new(
-        annotations: Vec<crate::datadogV2::model::LLMObsAnnotationItem>,
-        content_id: String,
-        id: String,
-        type_: crate::datadogV2::model::LLMObsInteractionType,
-    ) -> LLMObsAnnotatedInteractionItem {
-        LLMObsAnnotatedInteractionItem {
-            annotations,
-            content_id,
-            id,
-            type_,
-            additional_properties: std::collections::BTreeMap::new(),
-            _unparsed: false,
-        }
-    }
-
-    pub fn additional_properties(
-        mut self,
-        value: std::collections::BTreeMap<String, serde_json::Value>,
-    ) -> Self {
-        self.additional_properties = value;
-        self
-    }
+#[serde(untagged)]
+pub enum LLMObsAnnotatedInteractionItem {
+    LLMObsTraceAnnotatedInteractionItem(
+        Box<crate::datadogV2::model::LLMObsTraceAnnotatedInteractionItem>,
+    ),
+    LLMObsDisplayBlockAnnotatedInteractionItem(
+        Box<crate::datadogV2::model::LLMObsDisplayBlockAnnotatedInteractionItem>,
+    ),
+    UnparsedObject(crate::datadog::UnparsedObject),
 }
 
 impl<'de> Deserialize<'de> for LLMObsAnnotatedInteractionItem {
     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
     where
         D: Deserializer<'de>,
     {
-        struct LLMObsAnnotatedInteractionItemVisitor;
-        impl<'a> Visitor<'a> for LLMObsAnnotatedInteractionItemVisitor {
-            type Value = LLMObsAnnotatedInteractionItem;
-
-            fn expecting(&self, f: &mut Formatter<'_>) -> fmt::Result {
-                f.write_str("a mapping")
+        let value: serde_json::Value = Deserialize::deserialize(deserializer)?;
+        if let Ok(_v) = serde_json::from_value::<
+            Box<crate::datadogV2::model::LLMObsTraceAnnotatedInteractionItem>,
+        >(value.clone())
+        {
+            if !_v._unparsed {
+                return Ok(LLMObsAnnotatedInteractionItem::LLMObsTraceAnnotatedInteractionItem(_v));
             }
-
-            fn visit_map<M>(self, mut map: M) -> Result<Self::Value, M::Error>
-            where
-                M: MapAccess<'a>,
-            {
-                let mut annotations: Option<Vec<crate::datadogV2::model::LLMObsAnnotationItem>> =
-                    None;
-                let mut content_id: Option<String> = None;
-                let mut id: Option<String> = None;
-                let mut type_: Option<crate::datadogV2::model::LLMObsInteractionType> = None;
-                let mut additional_properties: std::collections::BTreeMap<
-                    String,
-                    serde_json::Value,
-                > = std::collections::BTreeMap::new();
-                let mut _unparsed = false;
-
-                while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
-                    match k.as_str() {
-                        "annotations" => {
-                            annotations =
-                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
-                        }
-                        "content_id" => {
-                            content_id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
-                        }
-                        "id" => {
-                            id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
-                        }
-                        "type" => {
-                            type_ = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
-                            if let Some(ref _type_) = type_ {
-                                match _type_ {
-                                    crate::datadogV2::model::LLMObsInteractionType::UnparsedObject(_type_) => {
-                                        _unparsed = true;
-                                    },
-                                    _ => {}
-                                }
-                            }
-                        }
-                        &_ => {
-                            if let Ok(value) = serde_json::from_value(v.clone()) {
-                                additional_properties.insert(k, value);
-                            }
-                        }
-                    }
-                }
-                let annotations =
-                    annotations.ok_or_else(|| M::Error::missing_field("annotations"))?;
-                let content_id = content_id.ok_or_else(|| M::Error::missing_field("content_id"))?;
-                let id = id.ok_or_else(|| M::Error::missing_field("id"))?;
-                let type_ = type_.ok_or_else(|| M::Error::missing_field("type_"))?;
-
-                let content = LLMObsAnnotatedInteractionItem {
-                    annotations,
-                    content_id,
-                    id,
-                    type_,
-                    additional_properties,
-                    _unparsed,
-                };
-
-                Ok(content)
+        }
+        if let Ok(_v) = serde_json::from_value::<
+            Box<crate::datadogV2::model::LLMObsDisplayBlockAnnotatedInteractionItem>,
+        >(value.clone())
+        {
+            if !_v._unparsed {
+                return Ok(
+                    LLMObsAnnotatedInteractionItem::LLMObsDisplayBlockAnnotatedInteractionItem(_v),
+                );
             }
         }
 
-        deserializer.deserialize_any(LLMObsAnnotatedInteractionItemVisitor)
+        return Ok(LLMObsAnnotatedInteractionItem::UnparsedObject(
+            crate::datadog::UnparsedObject { value },
+        ));
     }
 }