sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/agent_run.rb

@@ -0,0 +1,161 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # An agent run.
+  class AgentRun < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the run reached a terminal state. Unset until then.
+    # @return [String]
+    attr_accessor :completed_at
+
+    # When the run was created, as an ISO 8601 timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # Unique run id.
+    # @return [String]
+    attr_accessor :id
+
+    # Object type, always "agent.run".
+    # @return [String]
+    attr_accessor :object
+
+    # Object type, always "agent.run".
+    # @return [AgentRunOutput2]
+    attr_accessor :output
+
+    # Object type, always "agent.run".
+    # @return [AgentRunRequest2]
+    attr_accessor :request
+
+    # When the run started. Unset while pending.
+    # @return [String]
+    attr_accessor :started_at
+
+    # When the run started. Unset while pending.
+    # @return [AgentRunStatus2]
+    attr_accessor :status
+
+    # When the run started. Unset while pending.
+    # @return [AgentRunStopReason2]
+    attr_accessor :stop_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['completed_at'] = 'completed_at'
+      @_hash['created_at'] = 'created_at'
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['output'] = 'output'
+      @_hash['request'] = 'request'
+      @_hash['started_at'] = 'started_at'
+      @_hash['status'] = 'status'
+      @_hash['stop_reason'] = 'stop_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        completed_at
+        created_at
+        id
+        object
+        output
+        request
+        started_at
+        status
+        stop_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        completed_at
+        output
+        request
+        started_at
+        stop_reason
+      ]
+    end
+
+    def initialize(completed_at: SKIP, created_at: SKIP, id: SKIP, object: SKIP,
+                   output: SKIP, request: SKIP, started_at: SKIP,
+                   status: AgentRunStatus2::PENDING, stop_reason: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @completed_at = completed_at unless completed_at == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @id = id unless id == SKIP
+      @object = object unless object == SKIP
+      @output = output unless output == SKIP
+      @request = request unless request == SKIP
+      @started_at = started_at unless started_at == SKIP
+      @status = status unless status == SKIP
+      @stop_reason = stop_reason unless stop_reason == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      completed_at = hash.key?('completed_at') ? hash['completed_at'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      object = hash.key?('object') ? hash['object'] : SKIP
+      output = AgentRunOutput2.from_hash(hash['output']) if hash['output']
+      request = AgentRunRequest2.from_hash(hash['request']) if hash['request']
+      started_at = hash.key?('started_at') ? hash['started_at'] : SKIP
+      status = hash['status'] ||= AgentRunStatus2::PENDING
+      stop_reason = hash.key?('stop_reason') ? hash['stop_reason'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentRun.new(completed_at: completed_at,
+                   created_at: created_at,
+                   id: id,
+                   object: object,
+                   output: output,
+                   request: request,
+                   started_at: started_at,
+                   status: status,
+                   stop_reason: stop_reason,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} completed_at: #{@completed_at}, created_at: #{@created_at}, id: #{@id},"\
+      " object: #{@object}, output: #{@output}, request: #{@request}, started_at: #{@started_at},"\
+      " status: #{@status}, stop_reason: #{@stop_reason}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} completed_at: #{@completed_at.inspect}, created_at: #{@created_at.inspect},"\
+      " id: #{@id.inspect}, object: #{@object.inspect}, output: #{@output.inspect}, request:"\
+      " #{@request.inspect}, started_at: #{@started_at.inspect}, status: #{@status.inspect},"\
+      " stop_reason: #{@stop_reason.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_citation.rb

@@ -0,0 +1,85 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # One citation supporting a grounded field.
+  class AgentRunCitation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `id` of the entry in `sources` this citation points at.
+    # @return [Integer]
+    attr_accessor :source_id
+
+    # URL of the cited document.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_id'] = 'source_id'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source_id
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_id: 0, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @source_id = source_id unless source_id == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      source_id = hash['source_id'] ||= 0
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentRunCitation.new(source_id: source_id,
+                           url: url,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_id: #{@source_id}, url: #{@url}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_id: #{@source_id.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_grounding.rb

@@ -0,0 +1,94 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Citations for one field of `output.structured`.
+  class AgentRunGrounding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Citations supporting this field's value.
+    # @return [Array[AgentRunCitation]]
+    attr_accessor :citations
+
+    # Dot-notation path into the structured output, e.g. "companies.0.ceo".
+    # @return [String]
+    attr_accessor :field
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['citations'] = 'citations'
+      @_hash['field'] = 'field'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        citations
+        field
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(citations: SKIP, field: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @citations = citations unless citations == SKIP
+      @field = field unless field == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      citations = nil
+      unless hash['citations'].nil?
+        citations = []
+        hash['citations'].each do |structure|
+          citations << (AgentRunCitation.from_hash(structure) if structure)
+        end
+      end
+
+      citations = SKIP unless hash.key?('citations')
+      field = hash.key?('field') ? hash['field'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentRunGrounding.new(citations: citations,
+                            field: field,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} citations: #{@citations}, field: #{@field}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} citations: #{@citations.inspect}, field: #{@field.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_output.rb

@@ -0,0 +1,131 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # A run's output.
+  class AgentRunOutput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Per-field citations for `structured`. Empty when there is no structured
+    # output.
+    # @return [Array[AgentRunGrounding]]
+    attr_accessor :grounding
+
+    # The sources cited by `text` or `grounding`, numbered in order of first
+    # citation.
+    # @return [Array[AgentRunSource]]
+    attr_accessor :sources
+
+    # Structured result shaped by the request's `output_schema`. Unset when the
+    # request had none. Fields that could not be grounded are expected to be
+    # null. On gRPC the object is JSON-encoded.
+    # @return [Object]
+    attr_accessor :structured
+
+    # Cited markdown report. Inline `\[n\]` markers cite the entry of `sources`
+    # whose `id` is `n`.
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grounding'] = 'grounding'
+      @_hash['sources'] = 'sources'
+      @_hash['structured'] = 'structured'
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        grounding
+        sources
+        structured
+        text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        structured
+        text
+      ]
+    end
+
+    def initialize(grounding: SKIP, sources: SKIP, structured: SKIP, text: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grounding = grounding unless grounding == SKIP
+      @sources = sources unless sources == SKIP
+      @structured = structured unless structured == SKIP
+      @text = text unless text == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      grounding = nil
+      unless hash['grounding'].nil?
+        grounding = []
+        hash['grounding'].each do |structure|
+          grounding << (AgentRunGrounding.from_hash(structure) if structure)
+        end
+      end
+
+      grounding = SKIP unless hash.key?('grounding')
+      # Parameter is an array, so we need to iterate through it
+      sources = nil
+      unless hash['sources'].nil?
+        sources = []
+        hash['sources'].each do |structure|
+          sources << (AgentRunSource.from_hash(structure) if structure)
+        end
+      end
+
+      sources = SKIP unless hash.key?('sources')
+      structured = hash.key?('structured') ? hash['structured'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentRunOutput.new(grounding: grounding,
+                         sources: sources,
+                         structured: structured,
+                         text: text,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grounding: #{@grounding}, sources: #{@sources}, structured: #{@structured},"\
+      " text: #{@text}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grounding: #{@grounding.inspect}, sources: #{@sources.inspect}, structured:"\
+      " #{@structured.inspect}, text: #{@text.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_output2.rb

@@ -0,0 +1,131 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The run's output. Its members are unset until the run completes.
+  class AgentRunOutput2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Per-field citations for `structured`. Empty when there is no structured
+    # output.
+    # @return [Array[AgentRunGrounding]]
+    attr_accessor :grounding
+
+    # The sources cited by `text` or `grounding`, numbered in order of first
+    # citation.
+    # @return [Array[AgentRunSource]]
+    attr_accessor :sources
+
+    # Structured result shaped by the request's `output_schema`. Unset when the
+    # request had none. Fields that could not be grounded are expected to be
+    # null. On gRPC the object is JSON-encoded.
+    # @return [Object]
+    attr_accessor :structured
+
+    # Cited markdown report. Inline `\[n\]` markers cite the entry of `sources`
+    # whose `id` is `n`.
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grounding'] = 'grounding'
+      @_hash['sources'] = 'sources'
+      @_hash['structured'] = 'structured'
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        grounding
+        sources
+        structured
+        text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        structured
+        text
+      ]
+    end
+
+    def initialize(grounding: SKIP, sources: SKIP, structured: SKIP, text: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grounding = grounding unless grounding == SKIP
+      @sources = sources unless sources == SKIP
+      @structured = structured unless structured == SKIP
+      @text = text unless text == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      grounding = nil
+      unless hash['grounding'].nil?
+        grounding = []
+        hash['grounding'].each do |structure|
+          grounding << (AgentRunGrounding.from_hash(structure) if structure)
+        end
+      end
+
+      grounding = SKIP unless hash.key?('grounding')
+      # Parameter is an array, so we need to iterate through it
+      sources = nil
+      unless hash['sources'].nil?
+        sources = []
+        hash['sources'].each do |structure|
+          sources << (AgentRunSource.from_hash(structure) if structure)
+        end
+      end
+
+      sources = SKIP unless hash.key?('sources')
+      structured = hash.key?('structured') ? hash['structured'] : SKIP
+      text = hash.key?('text') ? hash['text'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentRunOutput2.new(grounding: grounding,
+                          sources: sources,
+                          structured: structured,
+                          text: text,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grounding: #{@grounding}, sources: #{@sources}, structured: #{@structured},"\
+      " text: #{@text}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grounding: #{@grounding.inspect}, sources: #{@sources.inspect}, structured:"\
+      " #{@structured.inspect}, text: #{@text.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_request.rb

@@ -0,0 +1,100 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The request a run was created with.
+  class AgentRunRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The effort level the run executes at: the request's `effort`, or the
+    # default level when it named none.
+    # @return [String]
+    attr_accessor :effort
+
+    # The request's `output_schema`, when one was given. On gRPC the object is
+    # JSON-encoded.
+    # @return [Object]
+    attr_accessor :output_schema
+
+    # The natural-language question.
+    # @return [String]
+    attr_accessor :query
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['effort'] = 'effort'
+      @_hash['output_schema'] = 'output_schema'
+      @_hash['query'] = 'query'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        effort
+        output_schema
+        query
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        effort
+        output_schema
+      ]
+    end
+
+    def initialize(effort: SKIP, output_schema: SKIP, query: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @effort = effort unless effort == SKIP
+      @output_schema = output_schema unless output_schema == SKIP
+      @query = query unless query == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      effort = hash.key?('effort') ? hash['effort'] : SKIP
+      output_schema = hash.key?('output_schema') ? hash['output_schema'] : SKIP
+      query = hash.key?('query') ? hash['query'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AgentRunRequest.new(effort: effort,
+                          output_schema: output_schema,
+                          query: query,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} effort: #{@effort}, output_schema: #{@output_schema}, query: #{@query},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} effort: #{@effort.inspect}, output_schema: #{@output_schema.inspect},"\
+      " query: #{@query.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end