sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/agent_run_request2.rb

@@ -0,0 +1,100 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The request the run was created with.
+  class AgentRunRequest2 < 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.
+      AgentRunRequest2.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

data/lib/seltz_api/models/agent_run_source.rb

@@ -0,0 +1,86 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # One source a run cited.
+  class AgentRunSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier within the run, cited as `\[id\]` in `text` and as `source_id`
+    # in `grounding`.
+    # @return [Integer]
+    attr_accessor :id
+
+    # URL of the source document.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: 0, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless 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.
+      id = hash['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.
+      AgentRunSource.new(id: 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} id: #{@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} id: #{@id.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_status.rb

@@ -0,0 +1,49 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Where a run is in its lifecycle: pending → running → completed / failed /
+  # cancelled.
+  class AgentRunStatus
+    AGENT_RUN_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for RUNNING
+      RUNNING = 'running'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AGENT_RUN_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'running' then RUNNING
+      when 'completed' then COMPLETED
+      when 'failed' then FAILED
+      when 'cancelled' then CANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_status2.rb

@@ -0,0 +1,48 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Where the run is in its lifecycle.
+  class AgentRunStatus2
+    AGENT_RUN_STATUS2 = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for RUNNING
+      RUNNING = 'running'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AGENT_RUN_STATUS2.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'running' then RUNNING
+      when 'completed' then COMPLETED
+      when 'failed' then FAILED
+      when 'cancelled' then CANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_stop_reason.rb

@@ -0,0 +1,53 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Why a run stopped. `budget_reached` pairs with `completed` when the output
+  # so far is usable and with `failed` when it is not.
+  class AgentRunStopReason
+    AGENT_RUN_STOP_REASON = [
+      # TODO: Write general description for FINISHED
+      FINISHED = 'finished'.freeze,
+
+      # TODO: Write general description for BUDGET_REACHED
+      BUDGET_REACHED = 'budget_reached'.freeze,
+
+      # TODO: Write general description for TIMEOUT
+      TIMEOUT = 'timeout'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for INVALID_OUTPUT
+      INVALID_OUTPUT = 'invalid_output'.freeze,
+
+      # TODO: Write general description for INTERNAL_ERROR
+      INTERNAL_ERROR = 'internal_error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AGENT_RUN_STOP_REASON.include?(value)
+    end
+
+    def self.from_value(value, default_value = FINISHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'finished' then FINISHED
+      when 'budget_reached' then BUDGET_REACHED
+      when 'timeout' then TIMEOUT
+      when 'cancelled' then CANCELLED
+      when 'invalid_output' then INVALID_OUTPUT
+      when 'internal_error' then INTERNAL_ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/agent_run_stop_reason2.rb

@@ -0,0 +1,52 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Why the run stopped. Set once the run reaches a terminal state.
+  class AgentRunStopReason2
+    AGENT_RUN_STOP_REASON2 = [
+      # TODO: Write general description for FINISHED
+      FINISHED = 'finished'.freeze,
+
+      # TODO: Write general description for BUDGET_REACHED
+      BUDGET_REACHED = 'budget_reached'.freeze,
+
+      # TODO: Write general description for TIMEOUT
+      TIMEOUT = 'timeout'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for INVALID_OUTPUT
+      INVALID_OUTPUT = 'invalid_output'.freeze,
+
+      # TODO: Write general description for INTERNAL_ERROR
+      INTERNAL_ERROR = 'internal_error'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AGENT_RUN_STOP_REASON2.include?(value)
+    end
+
+    def self.from_value(value, default_value = FINISHED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'finished' then FINISHED
+      when 'budget_reached' then BUDGET_REACHED
+      when 'timeout' then TIMEOUT
+      when 'cancelled' then CANCELLED
+      when 'invalid_output' then INVALID_OUTPUT
+      when 'internal_error' then INTERNAL_ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/seltz_api/models/answer_http_request.rb

@@ -0,0 +1,172 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # JSON request body for `POST /v1/answer`.
+  class AnswerHttpRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API key. Either this or the `x-api-key` header must be supplied;
+    # the header takes precedence.
+    # @return [String]
+    attr_accessor :api_key
+
+    # When true, citations carry the document content text. Default false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_content
+
+    # Selects the answer tier, which determines behavior and billing.
+    # Omitted resolves to the default tier. Independent of `scope`; the
+    # response shape is unchanged.
+    # @return [String]
+    attr_accessor :model
+
+    # The natural-language question.
+    # @return [String]
+    attr_accessor :query
+
+    # Optional `OpenAI` `response_format` object (`{"type": "text" |
+    # "json_object" | "json_schema", ...}`), accepted as raw JSON exactly
+    # like `/v1/chat/completions`. Under a structured type no inline
+    # citations are added, so the answer stays schema-valid; a malformed
+    # value is a `400` before billing. Omitted leaves the answer as Markdown
+    # prose.
+    # Applies at every tier.
+    # @return [Object]
+    attr_accessor :response_format
+
+    # Restricts the grounding search to one scope.
+    # Currently available:
+    # - `news`
+    # - `wikipedia`
+    # - `people`
+    # - `companies`
+    # Omitted, empty or whitespace-only searches the default scope.
+    # @return [String]
+    attr_accessor :scope
+
+    # When true, stream the answer as OpenAI-mimic SSE chunks. Default false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :stream
+
+    # Steers how the answer is presented — tone, voice, format. It is
+    # subordinate to the grounding and citation rules, which stay in force.
+    # That precedence is instructional, not a sandbox. Omitted, empty or
+    # whitespace-only leaves the presentation unchanged. Applies at every
+    # tier and composes with `response_format`. At most 8 KiB of UTF-8; a
+    # longer value is a `400` before billing.
+    # @return [String]
+    attr_accessor :system_prompt
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_key'] = 'api_key'
+      @_hash['include_content'] = 'include_content'
+      @_hash['model'] = 'model'
+      @_hash['query'] = 'query'
+      @_hash['response_format'] = 'response_format'
+      @_hash['scope'] = 'scope'
+      @_hash['stream'] = 'stream'
+      @_hash['system_prompt'] = 'system_prompt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        include_content
+        model
+        response_format
+        scope
+        stream
+        system_prompt
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        model
+        scope
+        system_prompt
+      ]
+    end
+
+    def initialize(query:, api_key: SKIP, include_content: SKIP, model: SKIP,
+                   response_format: SKIP, scope: SKIP, stream: SKIP,
+                   system_prompt: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @api_key = api_key unless api_key == SKIP
+      @include_content = include_content unless include_content == SKIP
+      @model = model unless model == SKIP
+      @query = query
+      @response_format = response_format unless response_format == SKIP
+      @scope = scope unless scope == SKIP
+      @stream = stream unless stream == SKIP
+      @system_prompt = system_prompt unless system_prompt == 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.
+      query = hash.key?('query') ? hash['query'] : nil
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      include_content =
+        hash.key?('include_content') ? hash['include_content'] : SKIP
+      model = hash.key?('model') ? hash['model'] : SKIP
+      response_format =
+        hash.key?('response_format') ? hash['response_format'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      stream = hash.key?('stream') ? hash['stream'] : SKIP
+      system_prompt = hash.key?('system_prompt') ? hash['system_prompt'] : 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.
+      AnswerHttpRequest.new(query: query,
+                            api_key: api_key,
+                            include_content: include_content,
+                            model: model,
+                            response_format: response_format,
+                            scope: scope,
+                            stream: stream,
+                            system_prompt: system_prompt,
+                            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} api_key: #{@api_key}, include_content: #{@include_content}, model:"\
+      " #{@model}, query: #{@query}, response_format: #{@response_format}, scope: #{@scope},"\
+      " stream: #{@stream}, system_prompt: #{@system_prompt}, 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} api_key: #{@api_key.inspect}, include_content: #{@include_content.inspect},"\
+      " model: #{@model.inspect}, query: #{@query.inspect}, response_format:"\
+      " #{@response_format.inspect}, scope: #{@scope.inspect}, stream: #{@stream.inspect},"\
+      " system_prompt: #{@system_prompt.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/answer_http_response.rb

@@ -0,0 +1,93 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Buffered JSON response body for `POST /v1/answer`.
+  class AnswerHttpResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Markdown answer text. Inline citations follow the form
+    # `text ([Source Name](url))`.
+    # @return [String]
+    attr_accessor :answer
+
+    # The sources the answer was grounded in. Every source the answer was
+    # given is returned, whether or not the text cites it.
+    # @return [Array[HttpCitation]]
+    attr_accessor :citations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['answer'] = 'answer'
+      @_hash['citations'] = 'citations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(answer:, citations:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @answer = answer
+      @citations = citations
+      @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.
+      answer = hash.key?('answer') ? hash['answer'] : nil
+      # Parameter is an array, so we need to iterate through it
+      citations = nil
+      unless hash['citations'].nil?
+        citations = []
+        hash['citations'].each do |structure|
+          citations << (HttpCitation.from_hash(structure) if structure)
+        end
+      end
+
+      citations = nil unless hash.key?('citations')
+
+      # 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.
+      AnswerHttpResponse.new(answer: answer,
+                             citations: citations,
+                             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} answer: #{@answer}, citations: #{@citations}, 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} answer: #{@answer.inspect}, citations: #{@citations.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end