mencoro 1.0.0

data/lib/mencoro/models/ai_response_resource.rb

@@ -0,0 +1,412 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  # One captured AI answer with its citations
+  class AiResponseResource < ApiModelBase
+    attr_accessor :id
+
+    # The project this capture belongs to
+    attr_accessor :project_id
+
+    # The tracked query that was asked
+    attr_accessor :tracked_query_id
+
+    # The AI engine that answered
+    attr_accessor :engine
+
+    # The full answer text as the engine produced it
+    attr_accessor :response_text
+
+    # Sources the engine cited, in the order it cited them
+    attr_accessor :citations
+
+    # When the answer was captured, UTC
+    attr_accessor :captured_at
+
+    # Engine-reported model, when it reported one. Absent on captures taken before engines exposed it
+    attr_accessor :model_name
+
+    # Which sampling pass of the run this answer is, starting at 0
+    attr_accessor :pass_index
+
+    # How many passes that run took. Rows of one run share trackedQueryId and capturedAt
+    attr_accessor :pass_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'project_id' => :'projectId',
+        :'tracked_query_id' => :'trackedQueryId',
+        :'engine' => :'engine',
+        :'response_text' => :'responseText',
+        :'citations' => :'citations',
+        :'captured_at' => :'capturedAt',
+        :'model_name' => :'modelName',
+        :'pass_index' => :'passIndex',
+        :'pass_count' => :'passCount'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'project_id' => :'String',
+        :'tracked_query_id' => :'String',
+        :'engine' => :'String',
+        :'response_text' => :'String',
+        :'citations' => :'Array<CitationResource>',
+        :'captured_at' => :'Time',
+        :'model_name' => :'String',
+        :'pass_index' => :'Integer',
+        :'pass_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'model_name',
+      ])
+    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 `Mencoro::AiResponseResource` 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 `Mencoro::AiResponseResource`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = nil
+      end
+
+      if attributes.key?(:'tracked_query_id')
+        self.tracked_query_id = attributes[:'tracked_query_id']
+      else
+        self.tracked_query_id = nil
+      end
+
+      if attributes.key?(:'engine')
+        self.engine = attributes[:'engine']
+      else
+        self.engine = nil
+      end
+
+      if attributes.key?(:'response_text')
+        self.response_text = attributes[:'response_text']
+      else
+        self.response_text = nil
+      end
+
+      if attributes.key?(:'citations')
+        if (value = attributes[:'citations']).is_a?(Array)
+          self.citations = value
+        end
+      else
+        self.citations = nil
+      end
+
+      if attributes.key?(:'captured_at')
+        self.captured_at = attributes[:'captured_at']
+      else
+        self.captured_at = nil
+      end
+
+      if attributes.key?(:'model_name')
+        self.model_name = attributes[:'model_name']
+      end
+
+      if attributes.key?(:'pass_index')
+        self.pass_index = attributes[:'pass_index']
+      else
+        self.pass_index = nil
+      end
+
+      if attributes.key?(:'pass_count')
+        self.pass_count = attributes[:'pass_count']
+      else
+        self.pass_count = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_id cannot be nil.')
+      end
+
+      if @tracked_query_id.nil?
+        invalid_properties.push('invalid value for "tracked_query_id", tracked_query_id cannot be nil.')
+      end
+
+      if @engine.nil?
+        invalid_properties.push('invalid value for "engine", engine cannot be nil.')
+      end
+
+      if @response_text.nil?
+        invalid_properties.push('invalid value for "response_text", response_text cannot be nil.')
+      end
+
+      if @citations.nil?
+        invalid_properties.push('invalid value for "citations", citations cannot be nil.')
+      end
+
+      if @captured_at.nil?
+        invalid_properties.push('invalid value for "captured_at", captured_at cannot be nil.')
+      end
+
+      if @pass_index.nil?
+        invalid_properties.push('invalid value for "pass_index", pass_index cannot be nil.')
+      end
+
+      if @pass_index < 0
+        invalid_properties.push('invalid value for "pass_index", must be greater than or equal to 0.')
+      end
+
+      if @pass_count.nil?
+        invalid_properties.push('invalid value for "pass_count", pass_count cannot be nil.')
+      end
+
+      if @pass_count < 1
+        invalid_properties.push('invalid value for "pass_count", must be greater than or equal to 1.')
+      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 @id.nil?
+      return false if @project_id.nil?
+      return false if @tracked_query_id.nil?
+      return false if @engine.nil?
+      return false if @response_text.nil?
+      return false if @citations.nil?
+      return false if @captured_at.nil?
+      return false if @pass_index.nil?
+      return false if @pass_index < 0
+      return false if @pass_count.nil?
+      return false if @pass_count < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      @project_id = project_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracked_query_id Value to be assigned
+    def tracked_query_id=(tracked_query_id)
+      if tracked_query_id.nil?
+        fail ArgumentError, 'tracked_query_id cannot be nil'
+      end
+
+      @tracked_query_id = tracked_query_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] engine Value to be assigned
+    def engine=(engine)
+      if engine.nil?
+        fail ArgumentError, 'engine cannot be nil'
+      end
+
+      @engine = engine
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response_text Value to be assigned
+    def response_text=(response_text)
+      if response_text.nil?
+        fail ArgumentError, 'response_text cannot be nil'
+      end
+
+      @response_text = response_text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] citations Value to be assigned
+    def citations=(citations)
+      if citations.nil?
+        fail ArgumentError, 'citations cannot be nil'
+      end
+
+      @citations = citations
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] captured_at Value to be assigned
+    def captured_at=(captured_at)
+      if captured_at.nil?
+        fail ArgumentError, 'captured_at cannot be nil'
+      end
+
+      @captured_at = captured_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pass_index Value to be assigned
+    def pass_index=(pass_index)
+      if pass_index.nil?
+        fail ArgumentError, 'pass_index cannot be nil'
+      end
+
+      if pass_index < 0
+        fail ArgumentError, 'invalid value for "pass_index", must be greater than or equal to 0.'
+      end
+
+      @pass_index = pass_index
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pass_count Value to be assigned
+    def pass_count=(pass_count)
+      if pass_count.nil?
+        fail ArgumentError, 'pass_count cannot be nil'
+      end
+
+      if pass_count < 1
+        fail ArgumentError, 'invalid value for "pass_count", must be greater than or equal to 1.'
+      end
+
+      @pass_count = pass_count
+    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 &&
+          id == o.id &&
+          project_id == o.project_id &&
+          tracked_query_id == o.tracked_query_id &&
+          engine == o.engine &&
+          response_text == o.response_text &&
+          citations == o.citations &&
+          captured_at == o.captured_at &&
+          model_name == o.model_name &&
+          pass_index == o.pass_index &&
+          pass_count == o.pass_count
+    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
+      [id, project_id, tracked_query_id, engine, response_text, citations, captured_at, model_name, pass_index, pass_count].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/mencoro/models/apply_clustering_job_outcome.rb

@@ -0,0 +1,199 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  # Per-tracked-query results of applying a clustering job
+  class ApplyClusteringJobOutcome < ApiModelBase
+    # Tracked queries written, each with the cluster ids it ended up with - the resulting state, not the delta.
+    attr_accessor :successful
+
+    # Always present, empty list included: read it rather than inferring success from the status code.
+    attr_accessor :failed
+
+    # Every cluster the assignments referred to, and whether this call created it.
+    attr_accessor :clusters
+
+    # Proposed names the store cannot hold. A tracked query whose proposed cluster was skipped ends up with fewer clusters than the proposal showed.
+    attr_accessor :skipped_clusters
+
+    # Tracked queries the job produced no assignment for. Nothing was written for them and they keep the clusters they already had, under every merge mode.
+    attr_accessor :unassigned
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'successful',
+        :'failed' => :'failed',
+        :'clusters' => :'clusters',
+        :'skipped_clusters' => :'skippedClusters',
+        :'unassigned' => :'unassigned'
+      }
+    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
+      {
+        :'successful' => :'Array<ApplyClusteringJobOutcomeSuccessfulInner>',
+        :'failed' => :'Array<ApplyClusteringJobOutcomeFailedInner>',
+        :'clusters' => :'Array<ApplyClusteringJobOutcomeClustersInner>',
+        :'skipped_clusters' => :'Array<ApplyClusteringJobOutcomeSkippedClustersInner>',
+        :'unassigned' => :'Array<String>'
+      }
+    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 `Mencoro::ApplyClusteringJobOutcome` 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 `Mencoro::ApplyClusteringJobOutcome`. 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?(:'successful')
+        if (value = attributes[:'successful']).is_a?(Array)
+          self.successful = value
+        end
+      end
+
+      if attributes.key?(:'failed')
+        if (value = attributes[:'failed']).is_a?(Array)
+          self.failed = value
+        end
+      end
+
+      if attributes.key?(:'clusters')
+        if (value = attributes[:'clusters']).is_a?(Array)
+          self.clusters = value
+        end
+      end
+
+      if attributes.key?(:'skipped_clusters')
+        if (value = attributes[:'skipped_clusters']).is_a?(Array)
+          self.skipped_clusters = value
+        end
+      end
+
+      if attributes.key?(:'unassigned')
+        if (value = attributes[:'unassigned']).is_a?(Array)
+          self.unassigned = value
+        end
+      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
+      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'
+      true
+    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 &&
+          successful == o.successful &&
+          failed == o.failed &&
+          clusters == o.clusters &&
+          skipped_clusters == o.skipped_clusters &&
+          unassigned == o.unassigned
+    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
+      [successful, failed, clusters, skipped_clusters, unassigned].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