trieve_ruby_client 0.6.7 → 0.7.2

data/lib/trieve_ruby_client/models/update_user_org_role_data.rb

@@ -0,0 +1,250 @@
+=begin
+#Trieve API
+
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
+
+The version of the OpenAPI document: 0.7.2
+Contact: developers@trieve.ai
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrieveRubyClient
+  class UpdateUserOrgRoleData
+    # The id of the organization to update the user for.
+    attr_accessor :organization_id
+
+    # Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned.
+    attr_accessor :role
+
+    # The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
+    attr_accessor :user_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'organization_id' => :'organization_id',
+        :'role' => :'role',
+        :'user_id' => :'user_id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'organization_id' => :'String',
+        :'role' => :'Integer',
+        :'user_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'user_id'
+      ])
+    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 `TrieveRubyClient::UpdateUserOrgRoleData` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::UpdateUserOrgRoleData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      else
+        self.organization_id = nil
+      end
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      else
+        self.role = nil
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      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 @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      end
+
+      if @role.nil?
+        invalid_properties.push('invalid value for "role", role 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 @organization_id.nil?
+      return false if @role.nil?
+      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 &&
+          organization_id == o.organization_id &&
+          role == o.role &&
+          user_id == o.user_id
+    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
+      [organization_id, role, user_id].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = TrieveRubyClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/trieve_ruby_client/models/upload_file_data.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.6.7
+The version of the OpenAPI document: 0.7.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/upload_file_result.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.6.7
+The version of the OpenAPI document: 0.7.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/user_organization.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.6.7
+The version of the OpenAPI document: 0.7.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/version.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.6.7
+The version of the OpenAPI document: 0.7.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -11,5 +11,5 @@ Generator version: 7.4.0
 =end
 
 module TrieveRubyClient
-  VERSION = '0.6.7'
+  VERSION = '0.7.2'
 end

data/lib/trieve_ruby_client.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.6.7
+The version of the OpenAPI document: 0.7.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -96,7 +96,7 @@ require 'trieve_ruby_client/models/update_dataset_request'
 require 'trieve_ruby_client/models/update_group_by_tracking_id_data'
 require 'trieve_ruby_client/models/update_organization_data'
 require 'trieve_ruby_client/models/update_topic_data'
-require 'trieve_ruby_client/models/update_user_data'
+require 'trieve_ruby_client/models/update_user_org_role_data'
 require 'trieve_ruby_client/models/upload_file_data'
 require 'trieve_ruby_client/models/upload_file_result'
 require 'trieve_ruby_client/models/user_organization'

data/openapi-generator.yaml

@@ -5,5 +5,5 @@ gemHomepage: "https://trieve.ai"
 gemLicense: "MIT"
 gemName: "trieve_ruby_client"
 gemSummary: "Trieve Ruby API client"
-gemVersion: "0.6.7"
+gemVersion: "0.7.2"
 moduleName: "TrieveRubyClient"

data/openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.6.7"
+    "version": "0.7.2"
   },
   "servers": [
     {
@@ -2558,15 +2558,6 @@
               "type": "string",
               "format": "uuid"
             }
-          },
-          {
-            "name": "delete_chunks",
-            "in": "query",
-            "description": "Whether or not to delete the chunks associated with the file",
-            "required": true,
-            "schema": {
-              "type": "boolean"
-            }
           }
         ],
         "responses": {
@@ -3461,7 +3452,7 @@
           "topic"
         ],
         "summary": "Create Topic",
-        "description": "Create Topic\n\nCreate a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.",
+        "description": "Create Topic\n\nCreate a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions.",
         "operationId": "create_topic",
         "parameters": [
           {
@@ -3568,23 +3559,22 @@
         ]
       }
     },
-    "/api/topic/user/{user_id}": {
+    "/api/topic/owner/{owner_id}": {
       "get": {
         "tags": [
           "topic"
         ],
-        "summary": "Get All Topics for User",
-        "description": "Get All Topics for User\n\nGet all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.",
-        "operationId": "get_all_topics_for_user",
+        "summary": "Get All Topics for Owner ID",
+        "description": "Get All Topics for Owner ID\n\nGet all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id.",
+        "operationId": "get_all_topics_for_owner_id",
         "parameters": [
           {
-            "name": "user_id",
+            "name": "owner_id",
             "in": "path",
-            "description": "The id of the user to get topics for",
+            "description": "The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           },
           {
@@ -3599,7 +3589,7 @@
         ],
         "responses": {
           "200": {
-            "description": "All topics belonging to a given user",
+            "description": "All topics belonging to a given owner_id",
             "content": {
               "application/json": {
                 "schema": {
@@ -3612,7 +3602,7 @@
             }
           },
           "400": {
-            "description": "Service error relating to topic get",
+            "description": "Service error relating to getting topics for the owner_id",
             "content": {
               "application/json": {
                 "schema": {
@@ -3697,22 +3687,15 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/UpdateUserData"
+                "$ref": "#/components/schemas/UpdateUserOrgRoleData"
               }
             }
           },
           "required": true
         },
         "responses": {
-          "200": {
-            "description": "JSON body representing the updated user information",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/SlimUser"
-                }
-              }
-            }
+          "204": {
+            "description": "Confirmation that the user's role was updated"
           },
           "400": {
             "description": "Service error relating to updating the user",
@@ -4078,12 +4061,6 @@
             "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
             "nullable": true
           },
-          "file_id": {
-            "type": "string",
-            "format": "uuid",
-            "description": "File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks.",
-            "nullable": true
-          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -4532,7 +4509,8 @@
       "ClientDatasetConfiguration": {
         "type": "object",
         "required": [
-          "FILE_NAME_KEY"
+          "FILE_NAME_KEY",
+          "IMAGE_METADATA_KEY"
         ],
         "properties": {
           "CREATE_CHUNK_FEATURE": {
@@ -4557,6 +4535,9 @@
             "type": "string",
             "nullable": true
           },
+          "IMAGE_METADATA_KEY": {
+            "type": "string"
+          },
           "IMAGE_RANGE_END_KEY": {
             "type": "string",
             "nullable": true
@@ -4586,6 +4567,7 @@
           "FILE_NAME_KEY": "file_name_key",
           "FILTER_ITEMS": [],
           "FRONTMATTER_VALS": "frontmatter vals",
+          "IMAGE_METADATA_KEY": ".image_url",
           "IMAGE_RANGE_END_KEY": "image range end key",
           "IMAGE_RANGE_START_KEY": "image range start key",
           "LINES_BEFORE_SHOW_MORE": 10,
@@ -4726,6 +4708,11 @@
           },
           "server_configuration": {
             "description": "Server configuration for the dataset, can be arbitrary JSON. We recommend setting to `{}` to start. See docs.trieve.ai for more information or adjust with the admin dashboard."
+          },
+          "tracking_id": {
+            "type": "string",
+            "description": "Optional tracking ID for the dataset. Can be used to track the dataset in external systems.",
+            "nullable": true
           }
         },
         "example": {
@@ -4793,6 +4780,9 @@
       },
       "CreateTopicData": {
         "type": "object",
+        "required": [
+          "owner_id"
+        ],
         "properties": {
           "first_user_message": {
             "type": "string",
@@ -4808,6 +4798,10 @@
             "type": "string",
             "description": "The name of the topic. If this is not provided, the topic name is generated from the first_user_message.",
             "nullable": true
+          },
+          "owner_id": {
+            "type": "string",
+            "description": "The owner_id of the topic. This is typically a browser fingerprint or your user's id. It is used to group topics together for a user."
           }
         }
       },
@@ -4840,6 +4834,10 @@
             "format": "uuid"
           },
           "server_configuration": {},
+          "tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -4856,6 +4854,7 @@
           "server_configuration": {
             "key": "value"
           },
+          "tracking_id": "3",
           "updated_at": "2021-01-01T00:00:00"
         }
       },
@@ -4918,6 +4917,10 @@
             "type": "string",
             "format": "uuid"
           },
+          "tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -4931,6 +4934,7 @@
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
           "name": "Trieve",
           "organization_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "tracking_id": "3",
           "updated_at": "2021-01-01T00:00:00"
         }
       },
@@ -5333,7 +5337,7 @@
             "items": {
               "type": "string"
             },
-            "description": "The types of events to get. Any combination of file_uploaded, chunk_uploaded, chunk_action_failed, or chunk_updated. Leave undefined to get all events.",
+            "description": "The types of events to get. Any combination of file_uploaded, chunk_uploaded, chunk_action_failed, chunk_updated, or qdrant_index_failed. Leave undefined to get all events.",
             "nullable": true
           },
           "page": {
@@ -5788,6 +5792,11 @@
             "description": "The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks.",
             "nullable": true
           },
+          "recommend_type": {
+            "type": "string",
+            "description": "The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`.",
+            "nullable": true
+          },
           "slim_chunks": {
             "type": "boolean",
             "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.",
@@ -5859,6 +5868,11 @@
             "description": "The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.",
             "nullable": true
           },
+          "recommend_type": {
+            "type": "string",
+            "description": "The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`.",
+            "nullable": true
+          },
           "slim_chunks": {
             "type": "boolean",
             "description": "Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false.",
@@ -6819,12 +6833,12 @@
         "type": "object",
         "required": [
           "id",
-          "user_id",
           "name",
           "deleted",
           "created_at",
           "updated_at",
-          "dataset_id"
+          "dataset_id",
+          "owner_id"
         ],
         "properties": {
           "created_at": {
@@ -6845,13 +6859,12 @@
           "name": {
             "type": "string"
           },
+          "owner_id": {
+            "type": "string"
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
-          },
-          "user_id": {
-            "type": "string",
-            "format": "uuid"
           }
         },
         "example": {
@@ -6860,8 +6873,8 @@
           "deleted": false,
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
           "name": "Trieve",
-          "updated_at": "2021-01-01T00:00:00",
-          "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
+          "owner_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "updated_at": "2021-01-01T00:00:00"
         }
       },
       "UpdateChunkByTrackingIdData": {
@@ -7048,9 +7061,6 @@
       },
       "UpdateDatasetRequest": {
         "type": "object",
-        "required": [
-          "dataset_id"
-        ],
         "properties": {
           "client_configuration": {
             "description": "The new client configuration of the dataset, can be arbitrary JSON. See docs.trieve.ai for more information. If not provided, the client configuration will not be updated.",
@@ -7059,7 +7069,8 @@
           "dataset_id": {
             "type": "string",
             "format": "uuid",
-            "description": "The id of the dataset you want to update."
+            "description": "The id of the dataset you want to update.",
+            "nullable": true
           },
           "dataset_name": {
             "type": "string",
@@ -7069,6 +7080,11 @@
           "server_configuration": {
             "description": "The new server configuration of the dataset, can be arbitrary JSON. See docs.trieve.ai for more information. If not provided, the server configuration will not be updated.",
             "nullable": true
+          },
+          "tracking_id": {
+            "type": "string",
+            "description": "tracking ID for the dataset. Can be used to track the dataset in external systems.",
+            "nullable": true
           }
         },
         "example": {
@@ -7148,17 +7164,13 @@
           }
         }
       },
-      "UpdateUserData": {
+      "UpdateUserOrgRoleData": {
         "type": "object",
         "required": [
-          "organization_id"
+          "organization_id",
+          "role"
         ],
         "properties": {
-          "name": {
-            "type": "string",
-            "description": "In the sense of a legal name, not a username. The new name to assign to the user, if not provided, the current name will be used.",
-            "nullable": true
-          },
           "organization_id": {
             "type": "string",
             "format": "uuid",
@@ -7167,8 +7179,7 @@
           "role": {
             "type": "integer",
             "format": "int32",
-            "description": "Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned.",
-            "nullable": true
+            "description": "Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned."
           },
           "user_id": {
             "type": "string",