trieve_ruby_client 0.4.0 → 0.5.7

data/openapi.json

@@ -12,16 +12,16 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.4.0"
+    "version": "0.5.7"
   },
   "servers": [
-    {
-      "url": "http://localhost:8090",
-      "description": "Local development server"
-    },
     {
       "url": "https://api.trieve.ai",
       "description": "Production server"
+    },
+    {
+      "url": "http://localhost:8090",
+      "description": "Local development server"
     }
   ],
   "paths": {
@@ -150,8 +150,8 @@
         "tags": [
           "chunk"
         ],
-        "summary": "Create Chunk",
-        "description": "Create Chunk\n\nCreate a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.",
+        "summary": "Create or Upsert Chunk or Chunks",
+        "description": "Create or Upsert Chunk or Chunks\n\nCreate a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.",
         "operationId": "create_chunk",
         "parameters": [
           {
@@ -214,6 +214,58 @@
             ]
           }
         ]
+      },
+      "put": {
+        "tags": [
+          "chunk"
+        ],
+        "summary": "Update Chunk",
+        "description": "Update Chunk\n\nUpdate a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.",
+        "operationId": "update_chunk",
+        "parameters": [
+          {
+            "name": "TR-Dataset",
+            "in": "header",
+            "description": "The dataset id to use for the request",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "JSON request payload to update a chunk (chunk)",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateChunkData"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "204": {
+            "description": "No content Ok response indicating the chunk was updated as requested"
+          },
+          "400": {
+            "description": "Service error relating to to updating chunk, likely due to conflicting tracking_id",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "ApiKey": [
+              "admin"
+            ]
+          }
+        ]
       }
     },
     "/api/chunk/gen_suggestions": {
@@ -282,8 +334,8 @@
         "tags": [
           "chunk"
         ],
-        "summary": "RAG on User Defined Chunks",
-        "description": "RAG on User Defined Chunks\n\nThis endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.",
+        "summary": "RAG on Specified Chunks",
+        "description": "RAG on Specified Chunks\n\nThis endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.",
         "operationId": "generate_off_chunks",
         "parameters": [
           {
@@ -370,14 +422,11 @@
         },
         "responses": {
           "200": {
-            "description": "JSON response payload containing chunks with scores which are similar to those in the request body",
+            "description": "Chunks with embedding vectors which are similar to those in the request body",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/ChunkMetadataWithFileData"
-                  }
+                  "$ref": "#/components/schemas/RecommendChunksResponseTypes"
                 }
               }
             }
@@ -434,11 +483,11 @@
         },
         "responses": {
           "200": {
-            "description": "chunks which are similar to the embedding vector of the search query",
+            "description": "Chunks with embedding vectors which are similar to those in the request body",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchChunkQueryResponseBody"
+                  "$ref": "#/components/schemas/SearchChunkResponseTypes"
                 }
               }
             }
@@ -508,7 +557,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -568,7 +616,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -619,61 +666,6 @@
             }
           }
         },
-        "deprecated": true,
-        "security": [
-          {
-            "ApiKey": [
-              "admin"
-            ]
-          }
-        ]
-      }
-    },
-    "/api/chunk/update": {
-      "put": {
-        "tags": [
-          "chunk"
-        ],
-        "summary": "Update Chunk",
-        "description": "Update Chunk\n\nUpdate a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.",
-        "operationId": "update_chunk",
-        "parameters": [
-          {
-            "name": "TR-Dataset",
-            "in": "header",
-            "description": "The dataset id to use for the request",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "JSON request payload to update a chunk (chunk)",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UpdateChunkData"
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "204": {
-            "description": "No content Ok response indicating the chunk was updated as requested"
-          },
-          "400": {
-            "description": "Service error relating to to updating chunk, likely due to conflicting tracking_id",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponseBody"
-                }
-              }
-            }
-          }
-        },
         "security": [
           {
             "ApiKey": [
@@ -683,7 +675,7 @@
         ]
       }
     },
-    "/api/chunk/{tracking_or_chunk}/{chunk_id}": {
+    "/api/chunk/{chunk_id}": {
       "get": {
         "tags": [
           "chunk"
@@ -701,24 +693,14 @@
               "type": "string"
             }
           },
-          {
-            "name": "tracking_or_chunk",
-            "in": "path",
-            "description": "The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          },
           {
             "name": "chunk_id",
             "in": "path",
-            "description": "Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.",
+            "description": "Id of the chunk you want to fetch.",
             "required": true,
             "schema": {
               "type": "string",
-              "format": "uuid",
-              "nullable": true
+              "format": "uuid"
             }
           }
         ],
@@ -769,24 +751,14 @@
               "type": "string"
             }
           },
-          {
-            "name": "tracking_or_chunk",
-            "in": "path",
-            "description": "The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          },
           {
             "name": "chunk_id",
             "in": "path",
-            "description": "Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.",
+            "description": "Id of the chunk you want to fetch.",
             "required": true,
             "schema": {
               "type": "string",
-              "format": "uuid",
-              "nullable": true
+              "format": "uuid"
             }
           }
         ],
@@ -820,7 +792,7 @@
           "chunk_group"
         ],
         "summary": "Create Chunk Group",
-        "description": "Create Chunk Group\n\nCreate a new chunk_group.",
+        "description": "Create Chunk Group\n\nCreate a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.",
         "operationId": "create_chunk_group",
         "parameters": [
           {
@@ -879,7 +851,7 @@
           "chunk_group"
         ],
         "summary": "Update Group",
-        "description": "Update Group\n\nUpdate a chunk_group.",
+        "description": "Update Group\n\nUpdate a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.",
         "operationId": "update_chunk_group",
         "parameters": [
           {
@@ -933,7 +905,7 @@
           "chunk_group"
         ],
         "summary": "Add Chunk to Group",
-        "description": "Add Chunk to Group\n\nRoute to add a chunk to a group",
+        "description": "Add Chunk to Group\n\nRoute to add a chunk to a group.",
         "operationId": "add_chunk_to_group",
         "parameters": [
           {
@@ -982,7 +954,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1045,7 +1016,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1127,6 +1097,17 @@
         "summary": "Search Over Groups",
         "description": "Search Over Groups\n\nThis route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.",
         "operationId": "search_over_groups",
+        "parameters": [
+          {
+            "name": "TR-Dataset",
+            "in": "header",
+            "description": "The dataset id to use for the request",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "description": "JSON request payload to semantically search over groups",
           "content": {
@@ -1144,7 +1125,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchOverGroupsResponseBody"
+                  "$ref": "#/components/schemas/SearchOverGroupsResponseTypes"
                 }
               }
             }
@@ -1159,7 +1140,14 @@
               }
             }
           }
-        }
+        },
+        "security": [
+          {
+            "ApiKey": [
+              "readonly"
+            ]
+          }
+        ]
       }
     },
     "/api/chunk_group/recommend": {
@@ -1194,14 +1182,11 @@
         },
         "responses": {
           "200": {
-            "description": "JSON response payload containing chunks with scores which are similar to those in the request body",
+            "description": "JSON body representing the groups which are similar to the groups in the request",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/GroupScoreChunkDTO"
-                  }
+                  "$ref": "#/components/schemas/RecommendGroupChunkResponseTypes"
                 }
               }
             }
@@ -1262,7 +1247,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchGroupsResult"
+                  "$ref": "#/components/schemas/SearchWithinGroupResponseTypes"
                 }
               }
             }
@@ -1311,8 +1296,7 @@
             "description": "The id of the group to get the chunks from",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           },
           {
@@ -1349,7 +1333,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1409,7 +1392,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1423,7 +1405,7 @@
           "chunk_group"
         ],
         "summary": "Add Chunk to Group by Tracking ID",
-        "description": "Add Chunk to Group by Tracking ID\n\nRoute to add a chunk to a group by tracking id. Think of a bookmark as a chunk which is a member of a group.",
+        "description": "Add Chunk to Group by Tracking ID\n\nRoute to add a chunk to a group by tracking id.",
         "operationId": "add_chunk_to_group_by_tracking_id",
         "parameters": [
           {
@@ -1471,7 +1453,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1534,7 +1515,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1585,7 +1565,6 @@
             }
           }
         },
-        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1595,7 +1574,7 @@
         ]
       }
     },
-    "/api/chunk_group/{tracking_or_chunk}/{group_id}": {
+    "/api/chunk_group/{group_id}": {
       "get": {
         "tags": [
           "chunk_group"
@@ -1613,24 +1592,14 @@
               "type": "string"
             }
           },
-          {
-            "name": "tracking_or_chunk",
-            "in": "path",
-            "description": "The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          },
           {
             "name": "group_id",
             "in": "path",
-            "description": "Id of the group you want to fetch. This can be either the group_id or the tracking_id.",
+            "description": "Id of the group you want to fetch.",
             "required": true,
             "schema": {
               "type": "string",
-              "format": "uuid",
-              "nullable": true
+              "format": "uuid"
             }
           }
         ],
@@ -1681,24 +1650,14 @@
               "type": "string"
             }
           },
-          {
-            "name": "tracking_or_chunk",
-            "in": "path",
-            "description": "The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          },
           {
             "name": "group_id",
             "in": "path",
-            "description": "Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.",
+            "description": "Id of the group you want to fetch.",
             "required": true,
             "schema": {
               "type": "string",
-              "format": "uuid",
-              "nullable": true
+              "format": "uuid"
             }
           },
           {
@@ -1735,7 +1694,7 @@
         ]
       }
     },
-    "/api/chunk_group/{tracking_or_chunk}/{group_id}/{page}": {
+    "/api/chunk_group/{group_id}/{page}": {
       "get": {
         "tags": [
           "chunk_group"
@@ -1753,24 +1712,14 @@
               "type": "string"
             }
           },
-          {
-            "name": "tracking_or_chunk",
-            "in": "path",
-            "description": "The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          },
           {
             "name": "group_id",
             "in": "path",
-            "description": "Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.",
+            "description": "Id of the group you want to fetch.",
             "required": true,
             "schema": {
               "type": "string",
-              "format": "uuid",
-              "nullable": true
+              "format": "uuid"
             }
           },
           {
@@ -1781,6 +1730,7 @@
             "schema": {
               "type": "integer",
               "format": "int64",
+              "nullable": true,
               "minimum": 0
             }
           }
@@ -1934,58 +1884,6 @@
             ]
           }
         ]
-      },
-      "delete": {
-        "tags": [
-          "dataset"
-        ],
-        "summary": "Delete Dataset",
-        "description": "Delete Dataset\n\nDelete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.",
-        "operationId": "delete_dataset",
-        "parameters": [
-          {
-            "name": "TR-Organization",
-            "in": "header",
-            "description": "The organization id to use for the request",
-            "required": true,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "JSON request payload to delete a dataset",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/DeleteDatasetRequest"
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "204": {
-            "description": "Dataset deleted successfully"
-          },
-          "400": {
-            "description": "Service error relating to deleting the dataset",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponseBody"
-                }
-              }
-            }
-          }
-        },
-        "security": [
-          {
-            "ApiKey": [
-              "owner"
-            ]
-          }
-        ]
       }
     },
     "/api/dataset/envs": {
@@ -2312,31 +2210,82 @@
             ]
           }
         ]
-      }
-    },
-    "/api/events": {
-      "post": {
+      },
+      "delete": {
         "tags": [
-          "events"
+          "dataset"
         ],
-        "summary": "Get events for the dataset",
-        "description": "Get events for the dataset\n\nGet events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.",
-        "operationId": "get_events",
+        "summary": "Delete Dataset",
+        "description": "Delete Dataset\n\nDelete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.",
+        "operationId": "delete_dataset",
         "parameters": [
           {
-            "name": "TR-Dataset",
+            "name": "TR-Organization",
             "in": "header",
-            "description": "The dataset id to use for the request",
+            "description": "The organization id to use for the request",
             "required": true,
             "schema": {
               "type": "string"
             }
-          }
-        ],
-        "requestBody": {
-          "description": "JSON request payload to get events for a dataset",
-          "content": {
-            "application/json": {
+          },
+          {
+            "name": "dataset_id",
+            "in": "path",
+            "description": "The id of the dataset you want to delete.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Dataset deleted successfully"
+          },
+          "400": {
+            "description": "Service error relating to deleting the dataset",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "ApiKey": [
+              "owner"
+            ]
+          }
+        ]
+      }
+    },
+    "/api/events": {
+      "post": {
+        "tags": [
+          "events"
+        ],
+        "summary": "Get events for the dataset",
+        "description": "Get events for the dataset\n\nGet events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.",
+        "operationId": "get_events",
+        "parameters": [
+          {
+            "name": "TR-Dataset",
+            "in": "header",
+            "description": "The dataset id to use for the request",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "JSON request payload to get events for a dataset",
+          "content": {
+            "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/GetEventsData"
               }
@@ -3529,15 +3478,27 @@
             ]
           }
         ]
-      },
-      "delete": {
+      }
+    },
+    "/api/topic/user/{user_id}": {
+      "get": {
         "tags": [
           "topic"
         ],
-        "summary": "Delete Topic",
-        "description": "Delete Topic\n\nDelete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.",
-        "operationId": "delete_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",
         "parameters": [
+          {
+            "name": "user_id",
+            "in": "path",
+            "description": "The id of the user to get topics for",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
           {
             "name": "TR-Dataset",
             "in": "header",
@@ -3548,23 +3509,22 @@
             }
           }
         ],
-        "requestBody": {
-          "description": "JSON request payload to delete a chat topic",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/DeleteTopicData"
+        "responses": {
+          "200": {
+            "description": "All topics belonging to a given user",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Topic"
+                  }
+                }
               }
             }
           },
-          "required": true
-        },
-        "responses": {
-          "204": {
-            "description": "Confirmation that the topic was deleted"
-          },
           "400": {
-            "description": "Service error relating to topic deletion",
+            "description": "Service error relating to topic get",
             "content": {
               "application/json": {
                 "schema": {
@@ -3583,51 +3543,41 @@
         ]
       }
     },
-    "/api/topic/user/{user_id}": {
-      "get": {
+    "/api/topic/{topic_id}": {
+      "delete": {
         "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": "Delete Topic",
+        "description": "Delete Topic\n\nDelete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.",
+        "operationId": "delete_topic",
         "parameters": [
           {
-            "name": "user_id",
-            "in": "path",
-            "description": "The id of the user to get topics for",
+            "name": "TR-Dataset",
+            "in": "header",
+            "description": "The dataset id to use for the request",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           },
           {
-            "name": "TR-Dataset",
-            "in": "header",
-            "description": "The dataset id to use for the request",
+            "name": "topic_id",
+            "in": "path",
+            "description": "The id of the topic you want to delete.",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "format": "uuid"
             }
           }
         ],
         "responses": {
-          "200": {
-            "description": "All topics belonging to a given user",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/Topic"
-                  }
-                }
-              }
-            }
+          "204": {
+            "description": "Confirmation that the topic was deleted"
           },
           "400": {
-            "description": "Service error relating to topic get",
+            "description": "Service error relating to topic deletion",
             "content": {
               "application/json": {
                 "schema": {
@@ -3696,7 +3646,7 @@
         ]
       }
     },
-    "/api/user/delete_api_key": {
+    "/api/user/delete_api_key/{api_key_id}": {
       "delete": {
         "tags": [
           "user"
@@ -3704,17 +3654,18 @@
         "summary": "Delete User Api Key",
         "description": "Delete User Api Key\n\nDelete an api key for the auth'ed user.",
         "operationId": "delete_user_api_key",
-        "requestBody": {
-          "description": "JSON request payload to delete a user api key",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/DeleteUserApiKeyRequest"
-              }
+        "parameters": [
+          {
+            "name": "api_key_id",
+            "in": "path",
+            "description": "The id of the api key to delete",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
             }
-          },
-          "required": true
-        },
+          }
+        ],
         "responses": {
           "200": {
             "description": "JSON body representing the api_key for the user",
@@ -3811,7 +3762,7 @@
           "chunk_id": {
             "type": "string",
             "format": "uuid",
-            "description": "Id of the chunk to make a member of the group. Think of this as \"bookmark\"ing a chunk."
+            "description": "Id of the chunk to make a member of the group."
           }
         }
       },
@@ -4894,19 +4845,6 @@
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
         }
       },
-      "DeleteDatasetRequest": {
-        "type": "object",
-        "required": [
-          "dataset_id"
-        ],
-        "properties": {
-          "dataset_id": {
-            "type": "string",
-            "format": "uuid",
-            "description": "The id of the dataset you want to delete."
-          }
-        }
-      },
       "DeleteTopicData": {
         "type": "object",
         "required": [
@@ -5279,7 +5217,7 @@
             "items": {
               "type": "string"
             },
-            "description": "The type of events to get. Any combination of file_uploaded, card_uploaded, card_action_failed, or card_updated. Leave undefined to get all events.",
+            "description": "The types of events to get. Any combination of file_uploaded, card_uploaded, card_action_failed, or card_updated. Leave undefined to get all events.",
             "nullable": true
           },
           "page": {
@@ -5348,12 +5286,81 @@
             "type": "string",
             "format": "uuid"
           },
+          "group_tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
           "metadata": {
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/ScoreChunkDTO"
             }
           }
+        },
+        "example": {
+          "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "metadata": [
+            {
+              "metadata": [
+                {
+                  "content": "This is a test content",
+                  "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                  "link": "https://www.google.com",
+                  "metadata": {
+                    "key": "value"
+                  },
+                  "tag_set": "test",
+                  "time_stamp": "2021-01-01T00:00:00Z",
+                  "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                  "weight": 1
+                }
+              ],
+              "score": 0.5
+            }
+          ]
+        }
+      },
+      "GroupSlimChunksDTO": {
+        "type": "object",
+        "required": [
+          "group_id",
+          "metadata"
+        ],
+        "properties": {
+          "group_id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "metadata": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ScoreSlimChunks"
+            }
+          }
+        },
+        "example": {
+          "group_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "metadata": [
+            {
+              "metadata": [
+                {
+                  "created_at": "2021-01-01T00:00:00",
+                  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                  "link": "https://trieve.ai",
+                  "metadata": {
+                    "key": "value"
+                  },
+                  "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                  "tag_set": "tag1,tag2",
+                  "time_stamp": "2021-01-01T00:00:00",
+                  "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                  "updated_at": "2021-01-01T00:00:00",
+                  "weight": 0.5
+                }
+              ],
+              "score": 0.5
+            }
+          ]
         }
       },
       "InvitationData": {
@@ -5559,23 +5566,35 @@
         "type": "object",
         "properties": {
           "gt": {
-            "type": "number",
-            "format": "double",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RangeCondition"
+              }
+            ],
             "nullable": true
           },
           "gte": {
-            "type": "number",
-            "format": "double",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RangeCondition"
+              }
+            ],
             "nullable": true
           },
           "lt": {
-            "type": "number",
-            "format": "double",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RangeCondition"
+              }
+            ],
             "nullable": true
           },
           "lte": {
-            "type": "number",
-            "format": "double",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RangeCondition"
+              }
+            ],
             "nullable": true
           }
         },
@@ -5586,6 +5605,17 @@
           "lte": 1
         }
       },
+      "RangeCondition": {
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number",
+            "format": "double"
+          }
+        ]
+      },
       "ReccomendGroupChunksRequest": {
         "type": "object",
         "properties": {
@@ -5644,6 +5674,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
+          },
+          "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.",
+            "nullable": true
           }
         }
       },
@@ -5698,9 +5733,127 @@
             },
             "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
+          },
+          "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.",
+            "nullable": true
           }
         }
       },
+      "RecommendChunksResponseTypes": {
+        "oneOf": [
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ChunkMetadata"
+            },
+            "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",
+                "link": "https://trieve.ai",
+                "metadata": {
+                  "key": "value"
+                },
+                "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "tag_set": "tag1,tag2",
+                "time_stamp": "2021-01-01T00:00:00",
+                "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "updated_at": "2021-01-01T00:00:00",
+                "weight": 0.5
+              }
+            ]
+          },
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SlimChunkMetadata"
+            },
+            "example": [
+              {
+                "created_at": "2021-01-01T00:00:00",
+                "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "link": "https://trieve.ai",
+                "metadata": {
+                  "key": "value"
+                },
+                "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "tag_set": "tag1,tag2",
+                "time_stamp": "2021-01-01T00:00:00",
+                "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "updated_at": "2021-01-01T00:00:00",
+                "weight": 0.5
+              }
+            ]
+          }
+        ]
+      },
+      "RecommendGroupChunkResponseTypes": {
+        "oneOf": [
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/GroupSlimChunksDTO"
+            },
+            "example": [
+              {
+                "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                "metadata": [
+                  {
+                    "metadata": [
+                      {
+                        "content": "This is a test content",
+                        "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                        "link": "https://www.google.com",
+                        "metadata": {
+                          "key": "value"
+                        },
+                        "tag_set": "test",
+                        "time_stamp": "2021-01-01T00:00:00Z",
+                        "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                        "weight": 1
+                      }
+                    ],
+                    "score": 0.5
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/GroupScoreChunkDTO"
+            },
+            "example": {
+              "group_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+              "metadata": [
+                {
+                  "metadata": [
+                    {
+                      "id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                      "link": "https://www.google.com",
+                      "metadata": {
+                        "key": "value"
+                      },
+                      "tag_set": "test",
+                      "time_stamp": "2021-01-01T00:00:00Z",
+                      "tracking_id": "e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+                      "weight": 1
+                    }
+                  ],
+                  "score": 0.5
+                }
+              ]
+            }
+          }
+        ]
+      },
       "RegenerateMessageData": {
         "type": "object",
         "required": [
@@ -5783,6 +5936,44 @@
           "score": 0.5
         }
       },
+      "ScoreSlimChunks": {
+        "type": "object",
+        "required": [
+          "metadata",
+          "score"
+        ],
+        "properties": {
+          "metadata": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SlimChunkMetadata"
+            }
+          },
+          "score": {
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "example": {
+          "metadata": [
+            {
+              "created_at": "2021-01-01T00:00:00",
+              "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+              "link": "https://trieve.ai",
+              "metadata": {
+                "key": "value"
+              },
+              "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+              "tag_set": "tag1,tag2",
+              "time_stamp": "2021-01-01T00:00:00",
+              "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+              "updated_at": "2021-01-01T00:00:00",
+              "weight": 0.5
+            }
+          ],
+          "score": 0.5
+        }
+      },
       "SearchChunkData": {
         "type": "object",
         "required": [
@@ -5839,6 +6030,11 @@
             "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."
           },
+          "quote_negated_words": {
+            "type": "boolean",
+            "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.",
+            "nullable": true
+          },
           "score_threshold": {
             "type": "number",
             "format": "float",
@@ -5849,6 +6045,11 @@
             "type": "string",
             "description": "Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE."
           },
+          "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.",
+            "nullable": true
+          },
           "use_weights": {
             "type": "boolean",
             "description": "Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.",
@@ -5939,6 +6140,39 @@
           }
         }
       },
+      "SearchChunkResponseTypes": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/SearchSlimChunkQueryResponseBody"
+          },
+          {
+            "$ref": "#/components/schemas/SearchChunkQueryResponseBody"
+          }
+        ]
+      },
+      "SearchGroupSlimChunksResult": {
+        "type": "object",
+        "required": [
+          "bookmarks",
+          "group",
+          "total_pages"
+        ],
+        "properties": {
+          "bookmarks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ScoreSlimChunks"
+            }
+          },
+          "group": {
+            "$ref": "#/components/schemas/ChunkGroup"
+          },
+          "total_pages": {
+            "type": "integer",
+            "format": "int64"
+          }
+        }
+      },
       "SearchGroupsResult": {
         "type": "object",
         "required": [
@@ -6019,6 +6253,11 @@
             "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."
           },
+          "quote_negated_words": {
+            "type": "boolean",
+            "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.",
+            "nullable": true
+          },
           "score_threshold": {
             "type": "number",
             "format": "float",
@@ -6028,6 +6267,11 @@
           "search_type": {
             "type": "string",
             "description": "Can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE."
+          },
+          "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.",
+            "nullable": true
           }
         }
       },
@@ -6050,6 +6294,54 @@
           }
         }
       },
+      "SearchOverGroupsResponseTypes": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/SearchOverGroupsResponseBody"
+          },
+          {
+            "$ref": "#/components/schemas/SearchOverGroupsSlimChunksResponseBody"
+          }
+        ]
+      },
+      "SearchOverGroupsSlimChunksResponseBody": {
+        "type": "object",
+        "required": [
+          "group_chunks",
+          "total_chunk_pages"
+        ],
+        "properties": {
+          "group_chunks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/GroupSlimChunksDTO"
+            }
+          },
+          "total_chunk_pages": {
+            "type": "integer",
+            "format": "int64"
+          }
+        }
+      },
+      "SearchSlimChunkQueryResponseBody": {
+        "type": "object",
+        "required": [
+          "score_chunks",
+          "total_chunk_pages"
+        ],
+        "properties": {
+          "score_chunks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ScoreSlimChunks"
+            }
+          },
+          "total_chunk_pages": {
+            "type": "integer",
+            "format": "int64"
+          }
+        }
+      },
       "SearchWithinGroupData": {
         "type": "object",
         "required": [
@@ -6112,6 +6404,11 @@
             "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."
           },
+          "quote_negated_words": {
+            "type": "boolean",
+            "description": "Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.",
+            "nullable": true
+          },
           "score_threshold": {
             "type": "number",
             "format": "float",
@@ -6122,6 +6419,11 @@
             "type": "string",
             "description": "Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE."
           },
+          "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.",
+            "nullable": true
+          },
           "use_weights": {
             "type": "boolean",
             "description": "Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.",
@@ -6129,6 +6431,16 @@
           }
         }
       },
+      "SearchWithinGroupResponseTypes": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/SearchGroupsResult"
+          },
+          {
+            "$ref": "#/components/schemas/SearchGroupSlimChunksResult"
+          }
+        ]
+      },
       "SetUserApiKeyRequest": {
         "type": "object",
         "required": [
@@ -6202,6 +6514,73 @@
           "pos_in_queue": 1
         }
       },
+      "SlimChunkMetadata": {
+        "type": "object",
+        "required": [
+          "id",
+          "created_at",
+          "updated_at",
+          "weight"
+        ],
+        "properties": {
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "link": {
+            "type": "string",
+            "nullable": true
+          },
+          "metadata": {
+            "nullable": true
+          },
+          "qdrant_point_id": {
+            "type": "string",
+            "format": "uuid",
+            "nullable": true
+          },
+          "tag_set": {
+            "type": "string",
+            "nullable": true
+          },
+          "time_stamp": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true
+          },
+          "tracking_id": {
+            "type": "string",
+            "nullable": true
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "weight": {
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "example": {
+          "created_at": "2021-01-01T00:00:00",
+          "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "link": "https://trieve.ai",
+          "metadata": {
+            "key": "value"
+          },
+          "qdrant_point_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "tag_set": "tag1,tag2",
+          "time_stamp": "2021-01-01T00:00:00",
+          "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "updated_at": "2021-01-01T00:00:00",
+          "weight": 0.5
+        }
+      },
       "SlimGroup": {
         "type": "object",
         "required": [
@@ -6238,7 +6617,6 @@
         "required": [
           "id",
           "email",
-          "visible_email",
           "user_orgs",
           "orgs"
         ],
@@ -6265,17 +6643,6 @@
             "items": {
               "$ref": "#/components/schemas/UserOrganization"
             }
-          },
-          "username": {
-            "type": "string",
-            "nullable": true
-          },
-          "visible_email": {
-            "type": "boolean"
-          },
-          "website": {
-            "type": "string",
-            "nullable": true
           }
         },
         "example": {
@@ -6300,10 +6667,7 @@
               "updated_at": "2021-01-01T00:00:00",
               "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
             }
-          ],
-          "username": "trieve",
-          "visible_email": true,
-          "website": "https://trieve.ai"
+          ]
         }
       },
       "StripePlan": {
@@ -6548,6 +6912,14 @@
             "description": "The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used.",
             "nullable": true
           },
+          "tag_set": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used.",
+            "nullable": true
+          },
           "time_stamp": {
             "type": "string",
             "description": "Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used.",
@@ -6723,21 +7095,6 @@
             "format": "uuid",
             "description": "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.",
             "nullable": true
-          },
-          "username": {
-            "type": "string",
-            "description": "The new username to assign to the user, if not provided, the current username will be used.",
-            "nullable": true
-          },
-          "visible_email": {
-            "type": "boolean",
-            "description": "Determines if the user's email is visible to other users, if not provided, the current value will be used.",
-            "nullable": true
-          },
-          "website": {
-            "type": "string",
-            "description": "The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website.",
-            "nullable": true
           }
         }
       },