trieve_ruby_client 0.7.6 → 0.8.2

data/openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.7.6"
+    "version": "0.8.2"
   },
   "servers": [
     {
@@ -666,7 +666,14 @@
             }
           },
           "404": {
-            "description": "Chunk not found"
+            "description": "Chunk not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -779,7 +786,14 @@
             }
           },
           "404": {
-            "description": "Chunk not found"
+            "description": "Chunk not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1425,7 +1439,14 @@
             }
           },
           "404": {
-            "description": "Group not found"
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1487,7 +1508,14 @@
             }
           },
           "404": {
-            "description": "Group not found"
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1725,7 +1753,14 @@
             }
           },
           "404": {
-            "description": "Group not found"
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1860,7 +1895,14 @@
             }
           },
           "404": {
-            "description": "Group not found"
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1925,6 +1967,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Any one of the specified chunks not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1986,6 +2038,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Any one of the specified chunks not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -2665,6 +2727,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "File not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -3322,6 +3394,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Organization not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -4184,11 +4266,13 @@
       },
       "ChunkData": {
         "type": "object",
+        "required": [
+          "chunk_html"
+        ],
         "properties": {
           "chunk_html": {
             "type": "string",
-            "description": "HTML content of the chunk. 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.",
-            "nullable": true
+            "description": "HTML content of the chunk. 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."
           },
           "chunk_vector": {
             "type": "array",
@@ -4491,7 +4575,6 @@
         "type": "object",
         "required": [
           "id",
-          "content",
           "created_at",
           "updated_at",
           "dataset_id",
@@ -4502,9 +4585,6 @@
             "type": "string",
             "nullable": true
           },
-          "content": {
-            "type": "string"
-          },
           "created_at": {
             "type": "string",
             "format": "date-time"
@@ -4561,7 +4641,6 @@
         },
         "example": {
           "chunk_html": "<p>Hello, world!</p>",
-          "content": "Hello, world!",
           "created_at": "2021-01-01T00:00:00",
           "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
@@ -4581,7 +4660,6 @@
         "type": "object",
         "required": [
           "id",
-          "content",
           "created_at",
           "updated_at",
           "dataset_id",
@@ -4593,9 +4671,6 @@
             "type": "string",
             "nullable": true
           },
-          "content": {
-            "type": "string"
-          },
           "created_at": {
             "type": "string",
             "format": "date-time"
@@ -4841,6 +4916,11 @@
             "type": "string",
             "description": "Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.",
             "nullable": true
+          },
+          "upsert_by_tracking_id": {
+            "type": "boolean",
+            "description": "Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.",
+            "nullable": true
           }
         }
       },
@@ -5674,6 +5754,14 @@
             "type": "string",
             "format": "uuid"
           },
+          "group_name": {
+            "type": "string",
+            "nullable": true
+          },
+          "group_tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
           "metadata": {
             "type": "array",
             "items": {
@@ -5683,6 +5771,8 @@
         },
         "example": {
           "group_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "group_name": "Example Group",
+          "group_tracking_id": "example_tracking_id",
           "metadata": [
             {
               "metadata": [
@@ -5923,9 +6013,14 @@
           "dataset_count",
           "user_count",
           "file_storage",
-          "message_count"
+          "message_count",
+          "chunk_count"
         ],
         "properties": {
+          "chunk_count": {
+            "type": "integer",
+            "format": "int32"
+          },
           "dataset_count": {
             "type": "integer",
             "format": "int32"
@@ -5952,6 +6047,7 @@
           }
         },
         "example": {
+          "chunk_count": 1000,
           "dataset_count": 1,
           "file_storage": 512,
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
@@ -6077,7 +6173,7 @@
           },
           "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.",
+            "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 (typicall 10-50ms). Default is false.",
             "nullable": true
           },
           "strategy": {
@@ -6153,7 +6249,7 @@
           },
           "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.",
+            "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 (typicall 10-50ms). Default is false.",
             "nullable": true
           },
           "strategy": {
@@ -6285,11 +6381,6 @@
           "query"
         ],
         "properties": {
-          "date_bias": {
-            "type": "boolean",
-            "description": "Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode.",
-            "nullable": true
-          },
           "filters": {
             "allOf": [
               {
@@ -6303,6 +6394,11 @@
             "description": "Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.",
             "nullable": true
           },
+          "get_total_pages": {
+            "type": "boolean",
+            "description": "Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms).",
+            "nullable": true
+          },
           "highlight_delimiters": {
             "type": "array",
             "items": {
@@ -6313,7 +6409,7 @@
           },
           "highlight_results": {
             "type": "boolean",
-            "description": "Set highlight_results to true to highlight the results. If not specified, this defaults to true.",
+            "description": "Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences.",
             "nullable": true
           },
           "page": {
@@ -6334,6 +6430,12 @@
             "type": "string",
             "description": "Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set."
           },
+          "recency_bias": {
+            "type": "number",
+            "format": "float",
+            "description": "Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. We recommend setting this to 1.0 for a gentle reranking of the results, >3.0 for a strong reranking of the results.",
+            "nullable": true
+          },
           "score_threshold": {
             "type": "number",
             "format": "float",
@@ -6346,7 +6448,7 @@
           },
           "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.",
+            "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 (typicall 10-50ms). Default is false.",
             "nullable": true
           },
           "use_weights": {
@@ -6459,6 +6561,11 @@
             "description": "Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.",
             "nullable": true
           },
+          "get_total_pages": {
+            "type": "boolean",
+            "description": "Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms).",
+            "nullable": true
+          },
           "group_size": {
             "type": "integer",
             "format": "int32",
@@ -6476,7 +6583,7 @@
           },
           "highlight_results": {
             "type": "boolean",
-            "description": "Set highlight_results to true to highlight the results. If not specified, this defaults to true.",
+            "description": "Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences.",
             "nullable": true
           },
           "page": {
@@ -6509,7 +6616,7 @@
           },
           "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.",
+            "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 (typicall 10-50ms). Default is false.",
             "nullable": true
           }
         }
@@ -6578,11 +6685,6 @@
           "search_type"
         ],
         "properties": {
-          "date_bias": {
-            "type": "boolean",
-            "description": "Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode.",
-            "nullable": true
-          },
           "filters": {
             "allOf": [
               {
@@ -6591,6 +6693,11 @@
             ],
             "nullable": true
           },
+          "get_total_pages": {
+            "type": "boolean",
+            "description": "Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms).",
+            "nullable": true
+          },
           "group_id": {
             "type": "string",
             "format": "uuid",
@@ -6612,7 +6719,7 @@
           },
           "highlight_results": {
             "type": "boolean",
-            "description": "Set highlight_results to true to highlight the results. If not specified, this defaults to true.",
+            "description": "Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences.",
             "nullable": true
           },
           "page": {
@@ -6633,6 +6740,12 @@
             "type": "string",
             "description": "The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set."
           },
+          "recency_bias": {
+            "type": "number",
+            "format": "float",
+            "description": "Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0.",
+            "nullable": true
+          },
           "score_threshold": {
             "type": "number",
             "format": "float",
@@ -6645,7 +6758,7 @@
           },
           "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.",
+            "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 (typicall 10-50ms). Default is false.",
             "nullable": true
           },
           "use_weights": {

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.7.6
+The version of the OpenAPI document: 0.8.2
 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.7.6
+The version of the OpenAPI document: 0.8.2
 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.7.6
+  version: 0.8.2
 platform: ruby
 authors:
 - Trieve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-03 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -434,6 +434,8 @@ files:
 - trieve_ruby_client-0.6.7.gem
 - trieve_ruby_client-0.6.9.gem
 - trieve_ruby_client-0.7.2.gem
+- trieve_ruby_client-0.7.6.gem
+- trieve_ruby_client-0.8.0.gem
 - trieve_ruby_client.gemspec
 homepage: https://trieve.ai
 licenses: