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

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

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

.generator/schemas/v2/openapi.yaml

@@ -120,8 +120,16 @@ func (a *LLMObservabilityApi) CreateLLMObsAnnotationQueue(ctx _context.Context,
 }
 
 // CreateLLMObsAnnotationQueueInteractions Add annotation queue interactions.
-// 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.
 func (a *LLMObservabilityApi) CreateLLMObsAnnotationQueueInteractions(ctx _context.Context, queueId string, body LLMObsAnnotationQueueInteractionsRequest) (LLMObsAnnotationQueueInteractionsResponse, *_nethttp.Response, error) {
 	var (
 		localVarHTTPMethod  = _nethttp.MethodPost

api/datadogV2/api_llm_observability.go

@@ -5,203 +5,101 @@
 package datadogV2
 
 import (
-	"fmt"
-
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// LLMObsAnnotatedInteractionItem An interaction with its associated annotations.
+// LLMObsAnnotatedInteractionItem - An interaction with its associated annotations.
 type LLMObsAnnotatedInteractionItem struct {
-	// List of annotations for this interaction.
-	Annotations []LLMObsAnnotationItem `json:"annotations"`
-	// Identifier of the content (trace ID or session ID) for this interaction.
-	ContentId string `json:"content_id"`
-	// Unique identifier of the interaction.
-	Id string `json:"id"`
-	// Type of interaction in an annotation queue.
-	Type LLMObsInteractionType `json:"type"`
-	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
-	UnparsedObject       map[string]interface{} `json:"-"`
-	AdditionalProperties map[string]interface{} `json:"-"`
-}
-
-// NewLLMObsAnnotatedInteractionItem instantiates a new LLMObsAnnotatedInteractionItem object.
-// This constructor will assign default values to properties that have it defined,
-// and makes sure properties required by API are set, but the set of arguments
-// will change when the set of required properties is changed.
-func NewLLMObsAnnotatedInteractionItem(annotations []LLMObsAnnotationItem, contentId string, id string, typeVar LLMObsInteractionType) *LLMObsAnnotatedInteractionItem {
-	this := LLMObsAnnotatedInteractionItem{}
-	this.Annotations = annotations
-	this.ContentId = contentId
-	this.Id = id
-	this.Type = typeVar
-	return &this
-}
-
-// NewLLMObsAnnotatedInteractionItemWithDefaults instantiates a new LLMObsAnnotatedInteractionItem object.
-// This constructor will only assign default values to properties that have it defined,
-// but it doesn't guarantee that properties required by API are set.
-func NewLLMObsAnnotatedInteractionItemWithDefaults() *LLMObsAnnotatedInteractionItem {
-	this := LLMObsAnnotatedInteractionItem{}
-	return &this
-}
-
-// GetAnnotations returns the Annotations field value.
-func (o *LLMObsAnnotatedInteractionItem) GetAnnotations() []LLMObsAnnotationItem {
-	if o == nil {
-		var ret []LLMObsAnnotationItem
-		return ret
-	}
-	return o.Annotations
-}
-
-// GetAnnotationsOk returns a tuple with the Annotations field value
-// and a boolean to check if the value has been set.
-func (o *LLMObsAnnotatedInteractionItem) GetAnnotationsOk() (*[]LLMObsAnnotationItem, bool) {
-	if o == nil {
-		return nil, false
-	}
-	return &o.Annotations, true
-}
-
-// SetAnnotations sets field value.
-func (o *LLMObsAnnotatedInteractionItem) SetAnnotations(v []LLMObsAnnotationItem) {
-	o.Annotations = v
-}
-
-// GetContentId returns the ContentId field value.
-func (o *LLMObsAnnotatedInteractionItem) GetContentId() string {
-	if o == nil {
-		var ret string
-		return ret
-	}
-	return o.ContentId
-}
-
-// GetContentIdOk returns a tuple with the ContentId field value
-// and a boolean to check if the value has been set.
-func (o *LLMObsAnnotatedInteractionItem) GetContentIdOk() (*string, bool) {
-	if o == nil {
-		return nil, false
-	}
-	return &o.ContentId, true
-}
-
-// SetContentId sets field value.
-func (o *LLMObsAnnotatedInteractionItem) SetContentId(v string) {
-	o.ContentId = v
-}
+	LLMObsTraceAnnotatedInteractionItem        *LLMObsTraceAnnotatedInteractionItem
+	LLMObsDisplayBlockAnnotatedInteractionItem *LLMObsDisplayBlockAnnotatedInteractionItem
 
-// GetId returns the Id field value.
-func (o *LLMObsAnnotatedInteractionItem) GetId() string {
-	if o == nil {
-		var ret string
-		return ret
-	}
-	return o.Id
-}
-
-// GetIdOk returns a tuple with the Id field value
-// and a boolean to check if the value has been set.
-func (o *LLMObsAnnotatedInteractionItem) GetIdOk() (*string, bool) {
-	if o == nil {
-		return nil, false
+	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
+	UnparsedObject interface{}
+}
+
+// LLMObsTraceAnnotatedInteractionItemAsLLMObsAnnotatedInteractionItem is a convenience function that returns LLMObsTraceAnnotatedInteractionItem wrapped in LLMObsAnnotatedInteractionItem.
+func LLMObsTraceAnnotatedInteractionItemAsLLMObsAnnotatedInteractionItem(v *LLMObsTraceAnnotatedInteractionItem) LLMObsAnnotatedInteractionItem {
+	return LLMObsAnnotatedInteractionItem{LLMObsTraceAnnotatedInteractionItem: v}
+}
+
+// LLMObsDisplayBlockAnnotatedInteractionItemAsLLMObsAnnotatedInteractionItem is a convenience function that returns LLMObsDisplayBlockAnnotatedInteractionItem wrapped in LLMObsAnnotatedInteractionItem.
+func LLMObsDisplayBlockAnnotatedInteractionItemAsLLMObsAnnotatedInteractionItem(v *LLMObsDisplayBlockAnnotatedInteractionItem) LLMObsAnnotatedInteractionItem {
+	return LLMObsAnnotatedInteractionItem{LLMObsDisplayBlockAnnotatedInteractionItem: v}
+}
+
+// UnmarshalJSON turns data into one of the pointers in the struct.
+func (obj *LLMObsAnnotatedInteractionItem) UnmarshalJSON(data []byte) error {
+	var err error
+	match := 0
+	// try to unmarshal data into LLMObsTraceAnnotatedInteractionItem
+	err = datadog.Unmarshal(data, &obj.LLMObsTraceAnnotatedInteractionItem)
+	if err == nil {
+		if obj.LLMObsTraceAnnotatedInteractionItem != nil && obj.LLMObsTraceAnnotatedInteractionItem.UnparsedObject == nil {
+			jsonLLMObsTraceAnnotatedInteractionItem, _ := datadog.Marshal(obj.LLMObsTraceAnnotatedInteractionItem)
+			if string(jsonLLMObsTraceAnnotatedInteractionItem) == "{}" { // empty struct
+				obj.LLMObsTraceAnnotatedInteractionItem = nil
+			} else {
+				match++
+			}
+		} else {
+			obj.LLMObsTraceAnnotatedInteractionItem = nil
+		}
+	} else {
+		obj.LLMObsTraceAnnotatedInteractionItem = nil
+	}
+
+	// try to unmarshal data into LLMObsDisplayBlockAnnotatedInteractionItem
+	err = datadog.Unmarshal(data, &obj.LLMObsDisplayBlockAnnotatedInteractionItem)
+	if err == nil {
+		if obj.LLMObsDisplayBlockAnnotatedInteractionItem != nil && obj.LLMObsDisplayBlockAnnotatedInteractionItem.UnparsedObject == nil {
+			jsonLLMObsDisplayBlockAnnotatedInteractionItem, _ := datadog.Marshal(obj.LLMObsDisplayBlockAnnotatedInteractionItem)
+			if string(jsonLLMObsDisplayBlockAnnotatedInteractionItem) == "{}" { // empty struct
+				obj.LLMObsDisplayBlockAnnotatedInteractionItem = nil
+			} else {
+				match++
+			}
+		} else {
+			obj.LLMObsDisplayBlockAnnotatedInteractionItem = nil
+		}
+	} else {
+		obj.LLMObsDisplayBlockAnnotatedInteractionItem = nil
 	}
-	return &o.Id, true
-}
-
-// SetId sets field value.
-func (o *LLMObsAnnotatedInteractionItem) SetId(v string) {
-	o.Id = v
-}
 
-// GetType returns the Type field value.
-func (o *LLMObsAnnotatedInteractionItem) GetType() LLMObsInteractionType {
-	if o == nil {
-		var ret LLMObsInteractionType
-		return ret
+	if match != 1 { // more than 1 match
+		// reset to nil
+		obj.LLMObsTraceAnnotatedInteractionItem = nil
+		obj.LLMObsDisplayBlockAnnotatedInteractionItem = nil
+		return datadog.Unmarshal(data, &obj.UnparsedObject)
 	}
-	return o.Type
+	return nil // exactly one match
 }
 
-// GetTypeOk returns a tuple with the Type field value
-// and a boolean to check if the value has been set.
-func (o *LLMObsAnnotatedInteractionItem) GetTypeOk() (*LLMObsInteractionType, bool) {
-	if o == nil {
-		return nil, false
+// MarshalJSON turns data from the first non-nil pointers in the struct to JSON.
+func (obj LLMObsAnnotatedInteractionItem) MarshalJSON() ([]byte, error) {
+	if obj.LLMObsTraceAnnotatedInteractionItem != nil {
+		return datadog.Marshal(&obj.LLMObsTraceAnnotatedInteractionItem)
 	}
-	return &o.Type, true
-}
-
-// SetType sets field value.
-func (o *LLMObsAnnotatedInteractionItem) SetType(v LLMObsInteractionType) {
-	o.Type = v
-}
 
-// MarshalJSON serializes the struct using spec logic.
-func (o LLMObsAnnotatedInteractionItem) MarshalJSON() ([]byte, error) {
-	toSerialize := map[string]interface{}{}
-	if o.UnparsedObject != nil {
-		return datadog.Marshal(o.UnparsedObject)
+	if obj.LLMObsDisplayBlockAnnotatedInteractionItem != nil {
+		return datadog.Marshal(&obj.LLMObsDisplayBlockAnnotatedInteractionItem)
 	}
-	toSerialize["annotations"] = o.Annotations
-	toSerialize["content_id"] = o.ContentId
-	toSerialize["id"] = o.Id
-	toSerialize["type"] = o.Type
 
-	for key, value := range o.AdditionalProperties {
-		toSerialize[key] = value
+	if obj.UnparsedObject != nil {
+		return datadog.Marshal(obj.UnparsedObject)
 	}
-	return datadog.Marshal(toSerialize)
+	return nil, nil // no data in oneOf schemas
 }
 
-// UnmarshalJSON deserializes the given payload.
-func (o *LLMObsAnnotatedInteractionItem) UnmarshalJSON(bytes []byte) (err error) {
-	all := struct {
-		Annotations *[]LLMObsAnnotationItem `json:"annotations"`
-		ContentId   *string                 `json:"content_id"`
-		Id          *string                 `json:"id"`
-		Type        *LLMObsInteractionType  `json:"type"`
-	}{}
-	if err = datadog.Unmarshal(bytes, &all); err != nil {
-		return datadog.Unmarshal(bytes, &o.UnparsedObject)
-	}
-	if all.Annotations == nil {
-		return fmt.Errorf("required field annotations missing")
-	}
-	if all.ContentId == nil {
-		return fmt.Errorf("required field content_id missing")
-	}
-	if all.Id == nil {
-		return fmt.Errorf("required field id missing")
-	}
-	if all.Type == nil {
-		return fmt.Errorf("required field type missing")
-	}
-	additionalProperties := make(map[string]interface{})
-	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"annotations", "content_id", "id", "type"})
-	} else {
-		return err
-	}
-
-	hasInvalidField := false
-	o.Annotations = *all.Annotations
-	o.ContentId = *all.ContentId
-	o.Id = *all.Id
-	if !all.Type.IsValid() {
-		hasInvalidField = true
-	} else {
-		o.Type = *all.Type
-	}
-
-	if len(additionalProperties) > 0 {
-		o.AdditionalProperties = additionalProperties
+// GetActualInstance returns the actual instance.
+func (obj *LLMObsAnnotatedInteractionItem) GetActualInstance() interface{} {
+	if obj.LLMObsTraceAnnotatedInteractionItem != nil {
+		return obj.LLMObsTraceAnnotatedInteractionItem
 	}
 
-	if hasInvalidField {
-		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	if obj.LLMObsDisplayBlockAnnotatedInteractionItem != nil {
+		return obj.LLMObsDisplayBlockAnnotatedInteractionItem
 	}
 
+	// all schemas are nil
 	return nil
 }