trieve_ruby_client 0.6.2 → 0.6.9

data/lib/trieve_ruby_client/models/update_topic_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.2
+The version of the OpenAPI document: 0.6.9
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/update_user_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.2
+The version of the OpenAPI document: 0.6.9
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

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.2
+The version of the OpenAPI document: 0.6.9
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -24,12 +24,12 @@ module TrieveRubyClient
     # Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.
     attr_accessor :description
 
-    # MIME type of the file being uploaded.
-    attr_accessor :file_mime_type
-
     # Name of the file being uploaded, including the extension.
     attr_accessor :file_name
 
+    # Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>`
+    attr_accessor :group_tracking_id
+
     # Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.
     attr_accessor :link
 
@@ -48,8 +48,8 @@ module TrieveRubyClient
         :'base64_file' => :'base64_file',
         :'create_chunks' => :'create_chunks',
         :'description' => :'description',
-        :'file_mime_type' => :'file_mime_type',
         :'file_name' => :'file_name',
+        :'group_tracking_id' => :'group_tracking_id',
         :'link' => :'link',
         :'metadata' => :'metadata',
         :'tag_set' => :'tag_set',
@@ -68,8 +68,8 @@ module TrieveRubyClient
         :'base64_file' => :'String',
         :'create_chunks' => :'Boolean',
         :'description' => :'String',
-        :'file_mime_type' => :'String',
         :'file_name' => :'String',
+        :'group_tracking_id' => :'String',
         :'link' => :'String',
         :'metadata' => :'Object',
         :'tag_set' => :'Array<String>',
@@ -82,6 +82,7 @@ module TrieveRubyClient
       Set.new([
         :'create_chunks',
         :'description',
+        :'group_tracking_id',
         :'link',
         :'metadata',
         :'tag_set',
@@ -118,18 +119,16 @@ module TrieveRubyClient
         self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'file_mime_type')
-        self.file_mime_type = attributes[:'file_mime_type']
-      else
-        self.file_mime_type = nil
-      end
-
       if attributes.key?(:'file_name')
         self.file_name = attributes[:'file_name']
       else
         self.file_name = nil
       end
 
+      if attributes.key?(:'group_tracking_id')
+        self.group_tracking_id = attributes[:'group_tracking_id']
+      end
+
       if attributes.key?(:'link')
         self.link = attributes[:'link']
       end
@@ -158,10 +157,6 @@ module TrieveRubyClient
         invalid_properties.push('invalid value for "base64_file", base64_file cannot be nil.')
       end
 
-      if @file_mime_type.nil?
-        invalid_properties.push('invalid value for "file_mime_type", file_mime_type cannot be nil.')
-      end
-
       if @file_name.nil?
         invalid_properties.push('invalid value for "file_name", file_name cannot be nil.')
       end
@@ -174,7 +169,6 @@ module TrieveRubyClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @base64_file.nil?
-      return false if @file_mime_type.nil?
       return false if @file_name.nil?
       true
     end
@@ -187,8 +181,8 @@ module TrieveRubyClient
           base64_file == o.base64_file &&
           create_chunks == o.create_chunks &&
           description == o.description &&
-          file_mime_type == o.file_mime_type &&
           file_name == o.file_name &&
+          group_tracking_id == o.group_tracking_id &&
           link == o.link &&
           metadata == o.metadata &&
           tag_set == o.tag_set &&
@@ -204,7 +198,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [base64_file, create_chunks, description, file_mime_type, file_name, link, metadata, tag_set, time_stamp].hash
+      [base64_file, create_chunks, description, file_name, group_tracking_id, link, metadata, tag_set, time_stamp].hash
     end
 
     # Builds the object from hash

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.2
+The version of the OpenAPI document: 0.6.9
 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.2
+The version of the OpenAPI document: 0.6.9
 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.2
+The version of the OpenAPI document: 0.6.9
 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.2'
+  VERSION = '0.6.9'
 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.2
+The version of the OpenAPI document: 0.6.9
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

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.2"
+gemVersion: "0.6.9"
 moduleName: "TrieveRubyClient"

data/openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.6.2"
+    "version": "0.6.9"
   },
   "servers": [
     {
@@ -496,7 +496,7 @@
           "chunk"
         ],
         "summary": "Search",
-        "description": "Search\n\nThis route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.",
+        "description": "Search\n\nThis route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.",
         "operationId": "search_chunk",
         "parameters": [
           {
@@ -4073,6 +4073,11 @@
             "description": "Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "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",
@@ -4721,6 +4726,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": {
@@ -4835,6 +4845,10 @@
             "format": "uuid"
           },
           "server_configuration": {},
+          "tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -4851,6 +4865,7 @@
           "server_configuration": {
             "key": "value"
           },
+          "tracking_id": "3",
           "updated_at": "2021-01-01T00:00:00"
         }
       },
@@ -4913,6 +4928,10 @@
             "type": "string",
             "format": "uuid"
           },
+          "tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -4926,6 +4945,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"
         }
       },
@@ -5397,6 +5417,10 @@
             "type": "string",
             "format": "uuid"
           },
+          "group_name": {
+            "type": "string",
+            "nullable": true
+          },
           "group_tracking_id": {
             "type": "string",
             "nullable": true
@@ -5779,6 +5803,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.",
@@ -5850,6 +5879,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.",
@@ -6866,6 +6900,11 @@
             "description": "HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "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
+          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -6923,6 +6962,11 @@
             "description": "Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "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
+          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -7029,9 +7073,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.",
@@ -7040,7 +7081,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",
@@ -7050,6 +7092,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": {
@@ -7163,8 +7210,7 @@
         "type": "object",
         "required": [
           "base64_file",
-          "file_name",
-          "file_mime_type"
+          "file_name"
         ],
         "properties": {
           "base64_file": {
@@ -7181,14 +7227,15 @@
             "description": "Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.",
             "nullable": true
           },
-          "file_mime_type": {
-            "type": "string",
-            "description": "MIME type of the file being uploaded."
-          },
           "file_name": {
             "type": "string",
             "description": "Name of the file being uploaded, including the extension."
           },
+          "group_tracking_id": {
+            "type": "string",
+            "description": "Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>`",
+            "nullable": true
+          },
           "link": {
             "type": "string",
             "description": "Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.",

data/spec/spec_helper.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.2
+The version of the OpenAPI document: 0.6.9
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/trieve_ruby_client.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trieve_ruby_client
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.9
 platform: ruby
 authors:
 - Trieve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -406,6 +406,8 @@ files:
 - trieve_ruby_client-0.5.0.gem
 - trieve_ruby_client-0.5.7.gem
 - trieve_ruby_client-0.6.0.gem
+- trieve_ruby_client-0.6.2.gem
+- trieve_ruby_client-0.6.7.gem
 - trieve_ruby_client.gemspec
 homepage: https://trieve.ai
 licenses: