datadog_api_client 2.50.0 → 2.51.0

data/lib/datadog_api_client/v2/models/llm_obs_experiment_metric.rb

@@ -0,0 +1,278 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # A metric associated with an LLM Observability experiment span.
+  class LLMObsExperimentMetric
+    include BaseGenericModel
+
+    # Assessment result for an LLM Observability experiment metric.
+    attr_accessor :assessment
+
+    # Boolean value. Used when `metric_type` is `boolean`.
+    attr_accessor :boolean_value
+
+    # Categorical value. Used when `metric_type` is `categorical`.
+    attr_accessor :categorical_value
+
+    # Error details for an experiment metric evaluation.
+    attr_accessor :error
+
+    # JSON value. Used when `metric_type` is `json`.
+    attr_accessor :json_value
+
+    # Label or name for the metric.
+    attr_reader :label
+
+    # Arbitrary metadata associated with the metric.
+    attr_accessor :metadata
+
+    # Type of metric recorded for an LLM Observability experiment.
+    attr_reader :metric_type
+
+    # Human-readable reasoning for the metric value.
+    attr_accessor :reasoning
+
+    # Numeric score value. Used when `metric_type` is `score`.
+    attr_accessor :score_value
+
+    # The ID of the span this metric measures.
+    attr_reader :span_id
+
+    # List of tags associated with the metric.
+    attr_accessor :tags
+
+    # Timestamp when the metric was recorded, in milliseconds since Unix epoch.
+    attr_reader :timestamp_ms
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'assessment' => :'assessment',
+        :'boolean_value' => :'boolean_value',
+        :'categorical_value' => :'categorical_value',
+        :'error' => :'error',
+        :'json_value' => :'json_value',
+        :'label' => :'label',
+        :'metadata' => :'metadata',
+        :'metric_type' => :'metric_type',
+        :'reasoning' => :'reasoning',
+        :'score_value' => :'score_value',
+        :'span_id' => :'span_id',
+        :'tags' => :'tags',
+        :'timestamp_ms' => :'timestamp_ms'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'assessment' => :'LLMObsMetricAssessment',
+        :'boolean_value' => :'Boolean',
+        :'categorical_value' => :'String',
+        :'error' => :'LLMObsExperimentMetricError',
+        :'json_value' => :'Hash<String, Object>',
+        :'label' => :'String',
+        :'metadata' => :'Hash<String, Object>',
+        :'metric_type' => :'LLMObsMetricScoreType',
+        :'reasoning' => :'String',
+        :'score_value' => :'Float',
+        :'span_id' => :'String',
+        :'tags' => :'Array<String>',
+        :'timestamp_ms' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::LLMObsExperimentMetric` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'assessment')
+        self.assessment = attributes[:'assessment']
+      end
+
+      if attributes.key?(:'boolean_value')
+        self.boolean_value = attributes[:'boolean_value']
+      end
+
+      if attributes.key?(:'categorical_value')
+        self.categorical_value = attributes[:'categorical_value']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'json_value')
+        self.json_value = attributes[:'json_value']
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'metric_type')
+        self.metric_type = attributes[:'metric_type']
+      end
+
+      if attributes.key?(:'reasoning')
+        self.reasoning = attributes[:'reasoning']
+      end
+
+      if attributes.key?(:'score_value')
+        self.score_value = attributes[:'score_value']
+      end
+
+      if attributes.key?(:'span_id')
+        self.span_id = attributes[:'span_id']
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'timestamp_ms')
+        self.timestamp_ms = attributes[:'timestamp_ms']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @label.nil?
+      return false if @metric_type.nil?
+      return false if @span_id.nil?
+      return false if @timestamp_ms.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param label [Object] Object to be assigned
+    # @!visibility private
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'invalid value for "label", label cannot be nil.'
+      end
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param metric_type [Object] Object to be assigned
+    # @!visibility private
+    def metric_type=(metric_type)
+      if metric_type.nil?
+        fail ArgumentError, 'invalid value for "metric_type", metric_type cannot be nil.'
+      end
+      @metric_type = metric_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param span_id [Object] Object to be assigned
+    # @!visibility private
+    def span_id=(span_id)
+      if span_id.nil?
+        fail ArgumentError, 'invalid value for "span_id", span_id cannot be nil.'
+      end
+      @span_id = span_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param timestamp_ms [Object] Object to be assigned
+    # @!visibility private
+    def timestamp_ms=(timestamp_ms)
+      if timestamp_ms.nil?
+        fail ArgumentError, 'invalid value for "timestamp_ms", timestamp_ms cannot be nil.'
+      end
+      @timestamp_ms = timestamp_ms
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          assessment == o.assessment &&
+          boolean_value == o.boolean_value &&
+          categorical_value == o.categorical_value &&
+          error == o.error &&
+          json_value == o.json_value &&
+          label == o.label &&
+          metadata == o.metadata &&
+          metric_type == o.metric_type &&
+          reasoning == o.reasoning &&
+          score_value == o.score_value &&
+          span_id == o.span_id &&
+          tags == o.tags &&
+          timestamp_ms == o.timestamp_ms &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [assessment, boolean_value, categorical_value, error, json_value, label, metadata, metric_type, reasoning, score_value, span_id, tags, timestamp_ms, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/llm_obs_experiment_metric_error.rb

@@ -0,0 +1,105 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Error details for an experiment metric evaluation.
+  class LLMObsExperimentMetricError
+    include BaseGenericModel
+
+    # Error message associated with the metric evaluation.
+    attr_accessor :message
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'message' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::LLMObsExperimentMetricError` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          message == o.message &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [message, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/llm_obs_experiment_request.rb

@@ -0,0 +1,123 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Request to create an LLM Observability experiment.
+  class LLMObsExperimentRequest
+    include BaseGenericModel
+
+    # Data object for creating an LLM Observability experiment.
+    attr_reader :data
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'LLMObsExperimentDataRequest'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::LLMObsExperimentRequest` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param data [Object] Object to be assigned
+    # @!visibility private
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'invalid value for "data", data cannot be nil.'
+      end
+      @data = data
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data, additional_properties].hash
+    end
+  end
+end

data/lib/datadog_api_client/v2/models/llm_obs_experiment_response.rb

@@ -0,0 +1,123 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: support@datadoghq.com
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ 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 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # Response containing a single LLM Observability experiment.
+  class LLMObsExperimentResponse
+    include BaseGenericModel
+
+    # Data object for an LLM Observability experiment.
+    attr_reader :data
+
+    attr_accessor :additional_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'data' => :'LLMObsExperimentDataResponse'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::LLMObsExperimentResponse` initialize method"
+      end
+
+      self.additional_properties = {}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          self.additional_properties[k.to_sym] = v
+        else
+          h[k.to_sym] = v
+        end
+      }
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param data [Object] Object to be assigned
+    # @!visibility private
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'invalid value for "data", data cannot be nil.'
+      end
+      @data = data
+    end
+
+    # Returns the object in the form of hash, with additionalProperties support.
+    # @return [Hash] Returns the object in the form of hash
+    # @!visibility private
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      self.additional_properties.each_pair do |attr, value|
+        hash[attr] = value
+      end
+      hash
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          additional_properties == o.additional_properties
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [data, additional_properties].hash
+    end
+  end
+end