temper-rb 0.5.1

data/lib/temper/generated/models/reweight_relationship_request.rb

@@ -0,0 +1,264 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # Request body for `POST /api/relationships/{edge_handle}/reweight`.
+  class ReweightRelationshipRequest < ApiModelBase
+    # Graded self-assessed confidence band. Required whenever any other authorship field is set.
+    attr_accessor :confidence
+
+    # The act-grain thread this write belongs to (`kb_events.correlation_id`). Optional, caller- minted, provenance-only. Rides independently of `invocation_id` and of authorship.
+    attr_accessor :correlation_id
+
+    # The invocation this act is correlated under (`kb_events.invocation_id`). Optional — a correlation aid, never a substitute for authn/authz.
+    attr_accessor :invocation_id
+
+    # The model that authored the act. Authorship field — requires `confidence`.
+    attr_accessor :model
+
+    # The persona/role the author acted as. Authorship field — requires `confidence`.
+    attr_accessor :persona
+
+    # Structured rationale for the act. Authorship field — requires `confidence`.
+    attr_accessor :rationale
+
+    # Free-text reasoning for the act. Authorship field — requires `confidence`.
+    attr_accessor :reasoning
+
+    attr_accessor :weight
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'confidence' => :'confidence',
+        :'correlation_id' => :'correlation_id',
+        :'invocation_id' => :'invocation_id',
+        :'model' => :'model',
+        :'persona' => :'persona',
+        :'rationale' => :'rationale',
+        :'reasoning' => :'reasoning',
+        :'weight' => :'weight'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'confidence' => :'ConfidenceBand',
+        :'correlation_id' => :'String',
+        :'invocation_id' => :'String',
+        :'model' => :'String',
+        :'persona' => :'String',
+        :'rationale' => :'String',
+        :'reasoning' => :'String',
+        :'weight' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'confidence',
+        :'correlation_id',
+        :'invocation_id',
+        :'model',
+        :'persona',
+        :'rationale',
+        :'reasoning',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Temper::Generated::ReweightRelationshipRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Temper::Generated::ReweightRelationshipRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'correlation_id')
+        self.correlation_id = attributes[:'correlation_id']
+      end
+
+      if attributes.key?(:'invocation_id')
+        self.invocation_id = attributes[:'invocation_id']
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'persona')
+        self.persona = attributes[:'persona']
+      end
+
+      if attributes.key?(:'rationale')
+        self.rationale = attributes[:'rationale']
+      end
+
+      if attributes.key?(:'reasoning')
+        self.reasoning = attributes[:'reasoning']
+      end
+
+      if attributes.key?(:'weight')
+        self.weight = attributes[:'weight']
+      else
+        self.weight = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @weight.nil?
+        invalid_properties.push('invalid value for "weight", weight cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @weight.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weight Value to be assigned
+    def weight=(weight)
+      if weight.nil?
+        fail ArgumentError, 'weight cannot be nil'
+      end
+
+      @weight = weight
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          confidence == o.confidence &&
+          correlation_id == o.correlation_id &&
+          invocation_id == o.invocation_id &&
+          model == o.model &&
+          persona == o.persona &&
+          rationale == o.rationale &&
+          reasoning == o.reasoning &&
+          weight == o.weight
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [confidence, correlation_id, invocation_id, model, persona, rationale, reasoning, weight].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+      hash
+    end
+
+  end
+
+end

data/lib/temper/generated/models/score_kind.rb

@@ -0,0 +1,104 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # Which quantity a hit's score is, named so that combining two of different kinds reads as the category error it is.  The values are the DEPLOYED column names the serving functions emit — not names invented here — so a caller who greps the SQL for one finds it, and each equals the [`super::act::ActQuantity::field`] of the act that produced the row.  **OPEN, like [`super::act::ActName`].** A new act brings a new quantity, and a closed vocabulary would make adding one a breaking change for every client. Openness costs nothing here because the operation a client performs on this value is EQUALITY — *are these two scores the same kind?* — never exhaustive enumeration. Contrast [`super::disposition::StageDisposition`], which stays closed precisely because consumers match it exhaustively.  **The ranges differ and these names do not say so.** `vec_norm` rescales a cosine distance as `1 - d/2` into `[0,1]`; `region_score` rescales the identical operator as `1 - d` and spans `[-0.6, 1.0]`; `graph_score` is unbounded. The range rides once per stage on [`super::envelope::StageResult::orders_by`] rather than per row — read it instead of assuming `[0,1]`, which is the live mistake in this family, not a hypothetical one.
+  module ScoreKind
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Temper::Generated.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/temper/generated/models/scoring.rb

@@ -0,0 +1,192 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # How one hit scored, and by what measure.  The kind travels WITH the number, which is what lets a row be understood on its own. Two hits whose `score_kind` differs hold values that must never be added, averaged, or sorted into one list — and unlike a bare field name, that is something a client can actually check.
+  class Scoring < ApiModelBase
+    # Read [`super::envelope::StageResult::orders_by`] for this quantity's RANGE. It is not carried per row because it is a property of the act, identical for every row of a stage.
+    attr_accessor :score
+
+    attr_accessor :score_kind
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'score' => :'score',
+        :'score_kind' => :'score_kind'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'score' => :'Float',
+        :'score_kind' => :'ScoreKind'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Temper::Generated::Scoring` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Temper::Generated::Scoring`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      else
+        self.score = nil
+      end
+
+      if attributes.key?(:'score_kind')
+        self.score_kind = attributes[:'score_kind']
+      else
+        self.score_kind = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @score.nil?
+        invalid_properties.push('invalid value for "score", score cannot be nil.')
+      end
+
+      if @score_kind.nil?
+        invalid_properties.push('invalid value for "score_kind", score_kind cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @score.nil?
+      return false if @score_kind.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if score.nil?
+        fail ArgumentError, 'score cannot be nil'
+      end
+
+      @score = score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score_kind Value to be assigned
+    def score_kind=(score_kind)
+      if score_kind.nil?
+        fail ArgumentError, 'score_kind cannot be nil'
+      end
+
+      @score_kind = score_kind
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          score == o.score &&
+          score_kind == o.score_kind
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [score, score_kind].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+      hash
+    end
+
+  end
+
+end