fetch_hive 0.2.5 → 0.2.8

data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_search422_response.rb

@@ -0,0 +1,164 @@
+=begin
+#Fetch Hive Public API
+
+#The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+
+The version of the OpenAPI document: 0.2.8
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FetchHive::Generated
+  class PostPublicWorkspacesKnowledgeBasesSearch422Response < ApiModelBase
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error'
+      }
+    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
+      {
+        :'error' => :'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 `FetchHive::Generated::PostPublicWorkspacesKnowledgeBasesSearch422Response` 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 `FetchHive::Generated::PostPublicWorkspacesKnowledgeBasesSearch422Response`. 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?(:'error')
+        self.error = attributes[:'error']
+      else
+        self.error = 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 @error.nil?
+        invalid_properties.push('invalid value for "error", error 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 @error.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] error Value to be assigned
+    def error=(error)
+      if error.nil?
+        fail ArgumentError, 'error cannot be nil'
+      end
+
+      @error = error
+    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 &&
+          error == o.error
+    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
+      [error].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/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_search_request.rb

@@ -0,0 +1,302 @@
+=begin
+#Fetch Hive Public API
+
+#The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+
+The version of the OpenAPI document: 0.2.8
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FetchHive::Generated
+  class PostPublicWorkspacesKnowledgeBasesSearchRequest < ApiModelBase
+    attr_accessor :search_query
+
+    attr_accessor :search_type
+
+    attr_accessor :search_chunk_limit
+
+    attr_accessor :search_score_threshold
+
+    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
+      {
+        :'search_query' => :'search_query',
+        :'search_type' => :'search_type',
+        :'search_chunk_limit' => :'search_chunk_limit',
+        :'search_score_threshold' => :'search_score_threshold'
+      }
+    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
+      {
+        :'search_query' => :'String',
+        :'search_type' => :'String',
+        :'search_chunk_limit' => :'Integer',
+        :'search_score_threshold' => :'Float'
+      }
+    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 `FetchHive::Generated::PostPublicWorkspacesKnowledgeBasesSearchRequest` 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 `FetchHive::Generated::PostPublicWorkspacesKnowledgeBasesSearchRequest`. 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?(:'search_query')
+        self.search_query = attributes[:'search_query']
+      else
+        self.search_query = nil
+      end
+
+      if attributes.key?(:'search_type')
+        self.search_type = attributes[:'search_type']
+      else
+        self.search_type = nil
+      end
+
+      if attributes.key?(:'search_chunk_limit')
+        self.search_chunk_limit = attributes[:'search_chunk_limit']
+      else
+        self.search_chunk_limit = nil
+      end
+
+      if attributes.key?(:'search_score_threshold')
+        self.search_score_threshold = attributes[:'search_score_threshold']
+      else
+        self.search_score_threshold = 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 @search_query.nil?
+        invalid_properties.push('invalid value for "search_query", search_query cannot be nil.')
+      end
+
+      if @search_type.nil?
+        invalid_properties.push('invalid value for "search_type", search_type cannot be nil.')
+      end
+
+      if @search_chunk_limit.nil?
+        invalid_properties.push('invalid value for "search_chunk_limit", search_chunk_limit cannot be nil.')
+      end
+
+      if @search_chunk_limit > 20
+        invalid_properties.push('invalid value for "search_chunk_limit", must be smaller than or equal to 20.')
+      end
+
+      if @search_chunk_limit < 1
+        invalid_properties.push('invalid value for "search_chunk_limit", must be greater than or equal to 1.')
+      end
+
+      if @search_score_threshold.nil?
+        invalid_properties.push('invalid value for "search_score_threshold", search_score_threshold cannot be nil.')
+      end
+
+      if @search_score_threshold > 1
+        invalid_properties.push('invalid value for "search_score_threshold", must be smaller than or equal to 1.')
+      end
+
+      if @search_score_threshold < 0
+        invalid_properties.push('invalid value for "search_score_threshold", must be greater than or equal to 0.')
+      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 @search_query.nil?
+      return false if @search_type.nil?
+      search_type_validator = EnumAttributeValidator.new('String', ["hybrid", "vector", "full_text"])
+      return false unless search_type_validator.valid?(@search_type)
+      return false if @search_chunk_limit.nil?
+      return false if @search_chunk_limit > 20
+      return false if @search_chunk_limit < 1
+      return false if @search_score_threshold.nil?
+      return false if @search_score_threshold > 1
+      return false if @search_score_threshold < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] search_query Value to be assigned
+    def search_query=(search_query)
+      if search_query.nil?
+        fail ArgumentError, 'search_query cannot be nil'
+      end
+
+      @search_query = search_query
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] search_type Object to be assigned
+    def search_type=(search_type)
+      validator = EnumAttributeValidator.new('String', ["hybrid", "vector", "full_text"])
+      unless validator.valid?(search_type)
+        fail ArgumentError, "invalid value for \"search_type\", must be one of #{validator.allowable_values}."
+      end
+      @search_type = search_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] search_chunk_limit Value to be assigned
+    def search_chunk_limit=(search_chunk_limit)
+      if search_chunk_limit.nil?
+        fail ArgumentError, 'search_chunk_limit cannot be nil'
+      end
+
+      if search_chunk_limit > 20
+        fail ArgumentError, 'invalid value for "search_chunk_limit", must be smaller than or equal to 20.'
+      end
+
+      if search_chunk_limit < 1
+        fail ArgumentError, 'invalid value for "search_chunk_limit", must be greater than or equal to 1.'
+      end
+
+      @search_chunk_limit = search_chunk_limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] search_score_threshold Value to be assigned
+    def search_score_threshold=(search_score_threshold)
+      if search_score_threshold.nil?
+        fail ArgumentError, 'search_score_threshold cannot be nil'
+      end
+
+      if search_score_threshold > 1
+        fail ArgumentError, 'invalid value for "search_score_threshold", must be smaller than or equal to 1.'
+      end
+
+      if search_score_threshold < 0
+        fail ArgumentError, 'invalid value for "search_score_threshold", must be greater than or equal to 0.'
+      end
+
+      @search_score_threshold = search_score_threshold
+    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 &&
+          search_query == o.search_query &&
+          search_type == o.search_type &&
+          search_chunk_limit == o.search_chunk_limit &&
+          search_score_threshold == o.search_score_threshold
+    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
+      [search_query, search_type, search_chunk_limit, search_score_threshold].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/fetch_hive/generated/models/sse_chunk.rb

@@ -1,9 +1,9 @@
 =begin
 #Fetch Hive Public API
 
-#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+#The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.5
+The version of the OpenAPI document: 0.2.8
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module FetchHive::Generated
-  # A single event in a Server-Sent Events stream. The `type` field is a runtime discriminator. Known values:   - `reasoning` — a reasoning / thinking chunk (prompt and agent streams)   - `response`  — a text chunk (prompt and agent streams)   - `tool`      — a tool invocation result (agent stream only)   - `usage`     — final token usage event; signals end of meaningful stream content   - `summary`   — auto-summarization event emitted before reasoning when a thread                   history was compressed (agent stream only)   - `error`     — server-side error during streaming  The stream is terminated by `data: [DONE]`, which is handled by the SSE parser and never surfaced as a chunk. 
+  # A single event in a Server-Sent Events stream. The `type` field is a runtime discriminator. Known values:   - `reasoning` — a reasoning / thinking chunk (prompt and agent streams)   - `response`  — a text chunk (prompt and agent streams)   - `tool`      — a tool invocation result (agent stream only)   - `artifact`  — a generated document or image descriptor (agent stream only)   - `usage`     — final token usage event; signals end of meaningful stream content   - `summary`   — auto-summarization event emitted before reasoning when a thread                   history was compressed (agent stream only)   - `error`     — server-side error during streaming  The stream is terminated by `data: [DONE]`, which is handled by the SSE parser and never surfaced as a chunk. 
   class SseChunk < ApiModelBase
     # Event type discriminator.
     attr_accessor :type
@@ -46,6 +46,8 @@ module FetchHive::Generated
     # Serialised JSON tool result. Present for `tool` events.
     attr_accessor :observation
 
+    attr_accessor :artifact
+
     # Reason the stream ended. Present on `usage` events (e.g. \"completed\").
     attr_accessor :stop_reason
 
@@ -79,6 +81,7 @@ module FetchHive::Generated
         :'tool_type' => :'tool_type',
         :'tool_input' => :'tool_input',
         :'observation' => :'observation',
+        :'artifact' => :'artifact',
         :'stop_reason' => :'stop_reason',
         :'summary_text' => :'summary_text',
         :'original_token_count' => :'original_token_count',
@@ -112,6 +115,7 @@ module FetchHive::Generated
         :'tool_type' => :'String',
         :'tool_input' => :'Hash<String, Object>',
         :'observation' => :'String',
+        :'artifact' => :'GeneratedArtifact',
         :'stop_reason' => :'String',
         :'summary_text' => :'String',
         :'original_token_count' => :'Integer',
@@ -186,6 +190,10 @@ module FetchHive::Generated
         self.observation = attributes[:'observation']
       end
 
+      if attributes.key?(:'artifact')
+        self.artifact = attributes[:'artifact']
+      end
+
       if attributes.key?(:'stop_reason')
         self.stop_reason = attributes[:'stop_reason']
       end
@@ -245,6 +253,7 @@ module FetchHive::Generated
           tool_type == o.tool_type &&
           tool_input == o.tool_input &&
           observation == o.observation &&
+          artifact == o.artifact &&
           stop_reason == o.stop_reason &&
           summary_text == o.summary_text &&
           original_token_count == o.original_token_count &&
@@ -263,7 +272,7 @@ module FetchHive::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, response, request_id, model, done, tool_id, tool, tool_type, tool_input, observation, stop_reason, summary_text, original_token_count, context_limit, provider, error, usage].hash
+      [type, response, request_id, model, done, tool_id, tool, tool_type, tool_input, observation, artifact, stop_reason, summary_text, original_token_count, context_limit, provider, error, usage].hash
     end
 
     # Builds the object from hash

data/lib/fetch_hive/generated/models/token_usage.rb

@@ -1,9 +1,9 @@
 =begin
 #Fetch Hive Public API
 
-#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+#The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.5
+The version of the OpenAPI document: 0.2.8
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/tool_invocation.rb

@@ -1,9 +1,9 @@
 =begin
 #Fetch Hive Public API
 
-#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+#The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.5
+The version of the OpenAPI document: 0.2.8
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/version.rb

@@ -1,9 +1,9 @@
 =begin
 #Fetch Hive Public API
 
-#The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
+#The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.5
+The version of the OpenAPI document: 0.2.8
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0