trieve_ruby_client 0.5.0 → 0.6.0

data/openapi.json

@@ -12,16 +12,16 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.5.0"
+    "version": "0.6.0"
   },
   "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": {
@@ -35,12 +35,35 @@
         "operationId": "login",
         "parameters": [
           {
-            "name": "content",
+            "name": "organization_id",
             "in": "query",
-            "description": "Query parameters for login to be included as kv pairs after ? on the request URL.",
-            "required": true,
+            "description": "ID of organization to authenticate into",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "nullable": true
+            }
+          },
+          {
+            "name": "redirect_uri",
+            "in": "query",
+            "description": "URL to redirect to after successful login",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "nullable": true
+            }
+          },
+          {
+            "name": "inv_code",
+            "in": "query",
+            "description": "Code sent via email as a result of successful call to send_invitation",
+            "required": false,
             "schema": {
-              "$ref": "#/components/schemas/AuthQuery"
+              "type": "string",
+              "format": "uuid",
+              "nullable": true
             }
           }
         ],
@@ -422,14 +445,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"
                 }
               }
             }
@@ -486,11 +506,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"
                 }
               }
             }
@@ -560,6 +580,7 @@
             }
           }
         },
+        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1100,6 +1121,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": {
@@ -1117,7 +1149,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchOverGroupsResponseBody"
+                  "$ref": "#/components/schemas/SearchOverGroupsResponseTypes"
                 }
               }
             }
@@ -1132,7 +1164,14 @@
               }
             }
           }
-        }
+        },
+        "security": [
+          {
+            "ApiKey": [
+              "readonly"
+            ]
+          }
+        ]
       }
     },
     "/api/chunk_group/recommend": {
@@ -1159,7 +1198,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/ReccomendGroupChunksRequest"
+                "$ref": "#/components/schemas/RecommendGroupChunksRequest"
               }
             }
           },
@@ -1167,14 +1206,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"
                 }
               }
             }
@@ -1235,7 +1271,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchGroupsResult"
+                  "$ref": "#/components/schemas/SearchWithinGroupResponseTypes"
                 }
               }
             }
@@ -1266,7 +1302,7 @@
           "chunk_group"
         ],
         "summary": "Get Chunks in Group by Tracking ID",
-        "description": "Get Chunks in Group by Tracking ID\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.",
+        "description": "Get Chunks in Group by Tracking ID\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.",
         "operationId": "get_chunks_in_group_by_tracking_id",
         "parameters": [
           {
@@ -1441,6 +1477,7 @@
             }
           }
         },
+        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1503,6 +1540,7 @@
             }
           }
         },
+        "deprecated": true,
         "security": [
           {
             "ApiKey": [
@@ -1626,7 +1664,7 @@
           "chunk_group"
         ],
         "summary": "Delete Group",
-        "description": "Delete Group\n\nThis will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.",
+        "description": "Delete Group\n\nThis will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.",
         "operationId": "delete_chunk_group",
         "parameters": [
           {
@@ -1688,7 +1726,7 @@
           "chunk_group"
         ],
         "summary": "Get Chunks in Group",
-        "description": "Get Chunks in Group\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.",
+        "description": "Get Chunks in Group\n\nRoute to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.",
         "operationId": "get_chunks_in_group",
         "parameters": [
           {
@@ -1872,58 +1910,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": {
@@ -2081,7 +2067,7 @@
           {
             "name": "page",
             "in": "path",
-            "description": "The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.",
+            "description": "The page of groups to fetch. Page is 1-indexed.",
             "required": true,
             "schema": {
               "type": "integer",
@@ -2250,6 +2236,57 @@
             ]
           }
         ]
+      },
+      "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-Dataset",
+            "in": "header",
+            "description": "The dataset id to use for the request",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "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": {
@@ -2258,7 +2295,7 @@
           "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.",
+        "description": "Get events for the dataset\n\nGet events for the dataset specified by the TR-Dataset header.",
         "operationId": "get_events",
         "parameters": [
           {
@@ -2380,7 +2417,7 @@
           "file"
         ],
         "summary": "Get File",
-        "description": "Get File\n\nDownload a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.",
+        "description": "Get File\n\nDownload a file based on its id.",
         "operationId": "get_file_handler",
         "parameters": [
           {
@@ -2438,7 +2475,7 @@
           "file"
         ],
         "summary": "Delete File",
-        "description": "Delete File\n\nDelete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.",
+        "description": "Delete File\n\nDelete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user must be an admin or owner of the dataset's organization to delete a file.",
         "operationId": "delete_file_handler",
         "parameters": [
           {
@@ -3467,15 +3504,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",
@@ -3486,23 +3535,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": {
@@ -3521,51 +3569,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": {
@@ -3634,7 +3672,7 @@
         ]
       }
     },
-    "/api/user/delete_api_key": {
+    "/api/user/delete_api_key/{api_key_id}": {
       "delete": {
         "tags": [
           "user"
@@ -3642,17 +3680,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",
@@ -3742,14 +3781,17 @@
     "schemas": {
       "AddChunkToGroupData": {
         "type": "object",
-        "required": [
-          "chunk_id"
-        ],
         "properties": {
           "chunk_id": {
             "type": "string",
             "format": "uuid",
-            "description": "Id of the chunk to make a member of the group."
+            "description": "Id of the chunk to make a member of the group.",
+            "nullable": true
+          },
+          "tracking_id": {
+            "type": "string",
+            "description": "Tracking Id of the chunk to make a member of the group.",
+            "nullable": true
           }
         }
       },
@@ -4103,10 +4145,10 @@
                 "value4"
               ],
               "range": {
-                "gt": 0.0,
-                "gte": 0.0,
-                "lt": 1.0,
-                "lte": 1.0
+                "gt": 0,
+                "gte": 0,
+                "lt": 1,
+                "lte": 1
               }
             }
           ],
@@ -4118,10 +4160,10 @@
                 "value6"
               ],
               "range": {
-                "gt": 0.0,
-                "gte": 0.0,
-                "lt": 1.0,
-                "lte": 1.0
+                "gt": 0,
+                "gte": 0,
+                "lt": 1,
+                "lte": 1
               }
             }
           ],
@@ -4133,10 +4175,10 @@
                 "value2"
               ],
               "range": {
-                "gt": 0.0,
-                "gte": 0.0,
-                "lt": 1.0,
-                "lte": 1.0
+                "gt": 0,
+                "gte": 0,
+                "lt": 1,
+                "lte": 1
               }
             }
           ]
@@ -4168,9 +4210,16 @@
             "type": "string",
             "format": "uuid"
           },
+          "metadata": {
+            "nullable": true
+          },
           "name": {
             "type": "string"
           },
+          "tag_set": {
+            "type": "string",
+            "nullable": true
+          },
           "tracking_id": {
             "type": "string",
             "nullable": true
@@ -4563,10 +4612,22 @@
             "type": "string",
             "description": "Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for."
           },
+          "metadata": {
+            "description": "Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.",
+            "nullable": true
+          },
           "name": {
             "type": "string",
             "description": "Name to assign to the chunk_group. Does not need to be unique."
           },
+          "tag_set": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.",
+            "nullable": true
+          },
           "tracking_id": {
             "type": "string",
             "description": "Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.",
@@ -4832,19 +4893,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": [
@@ -5029,10 +5077,10 @@
             "value2"
           ],
           "range": {
-            "gt": 0.0,
-            "gte": 0.0,
-            "lt": 1.0,
-            "lte": 1.0
+            "gt": 0,
+            "gte": 0,
+            "lt": 1,
+            "lte": 1
           }
         }
       },
@@ -5286,12 +5334,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": {
@@ -5497,34 +5614,63 @@
         "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
           }
         },
         "example": {
-          "gt": 0.0,
-          "gte": 0.0,
-          "lt": 1.0,
-          "lte": 1.0
+          "gt": 0,
+          "gte": 0,
+          "lt": 1,
+          "lte": 1
         }
       },
-      "ReccomendGroupChunksRequest": {
+      "RangeCondition": {
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "number",
+            "format": "double"
+          }
+        ]
+      },
+      "RecommendChunkMetadata": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/ChunkMetadata"
+        }
+      },
+      "RecommendChunksRequest": {
         "type": "object",
         "properties": {
           "filters": {
@@ -5535,57 +5681,86 @@
             ],
             "nullable": true
           },
-          "group_size": {
-            "type": "integer",
-            "format": "int32",
-            "description": "The number of chunks to fetch for each group. This is the number of chunks which will be returned in the response for each group. The default is 10.",
-            "nullable": true,
-            "minimum": 0
-          },
           "limit": {
             "type": "integer",
             "format": "int64",
-            "description": "The number of groups to return. This is the number of groups which will be returned in the response. The default is 10.",
+            "description": "The number of chunks to return. This is the number of chunks which will be returned in the response. The default is 10.",
             "nullable": true,
             "minimum": 0
           },
-          "negative_group_ids": {
+          "negative_chunk_ids": {
             "type": "array",
             "items": {
               "type": "string",
               "format": "uuid"
             },
-            "description": "The  ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.",
+            "description": "The ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.",
             "nullable": true
           },
-          "negative_group_tracking_ids": {
+          "negative_tracking_ids": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "description": "The  ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.",
+            "description": "The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.",
             "nullable": true
           },
-          "positive_group_ids": {
+          "positive_chunk_ids": {
             "type": "array",
             "items": {
               "type": "string",
               "format": "uuid"
             },
-            "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.",
+            "description": "The 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
           },
-          "positive_group_tracking_ids": {
+          "positive_tracking_ids": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "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.",
+            "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
+          },
+          "strategy": {
+            "type": "string",
+            "description": "Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives.",
             "nullable": true
           }
         }
       },
-      "RecommendChunksRequest": {
+      "RecommendChunksResponseTypes": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/RecommendChunkMetadata"
+          },
+          {
+            "$ref": "#/components/schemas/RecommendSlimChunkMetadata"
+          }
+        ]
+      },
+      "RecommendGroupChunkResponseTypes": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/RecommendGroupSlimChunksDTO"
+          },
+          {
+            "$ref": "#/components/schemas/RecommendGroupChunksDTO"
+          }
+        ]
+      },
+      "RecommendGroupChunksDTO": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/GroupScoreChunkDTO"
+        }
+      },
+      "RecommendGroupChunksRequest": {
         "type": "object",
         "properties": {
           "filters": {
@@ -5596,49 +5771,78 @@
             ],
             "nullable": true
           },
+          "group_size": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The number of chunks to fetch for each group. This is the number of chunks which will be returned in the response for each group. The default is 3. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to reduce latency due to content download and serialization.",
+            "nullable": true,
+            "minimum": 0
+          },
           "limit": {
             "type": "integer",
             "format": "int64",
-            "description": "The number of chunks to return. This is the number of chunks which will be returned in the response. The default is 10.",
+            "description": "The number of groups to return. This is the number of groups which will be returned in the response. The default is 10.",
             "nullable": true,
             "minimum": 0
           },
-          "negative_chunk_ids": {
+          "negative_group_ids": {
             "type": "array",
             "items": {
               "type": "string",
               "format": "uuid"
             },
-            "description": "The ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.",
+            "description": "The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.",
             "nullable": true
           },
-          "negative_tracking_ids": {
+          "negative_group_tracking_ids": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "description": "The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks.",
+            "description": "The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.",
             "nullable": true
           },
-          "positive_chunk_ids": {
+          "positive_group_ids": {
             "type": "array",
             "items": {
               "type": "string",
               "format": "uuid"
             },
-            "description": "The 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.",
+            "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
           },
-          "positive_tracking_ids": {
+          "positive_group_tracking_ids": {
             "type": "array",
             "items": {
               "type": "string"
             },
-            "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.",
+            "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
+          },
+          "strategy": {
+            "type": "string",
+            "description": "Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives.",
             "nullable": true
           }
         }
       },
+      "RecommendGroupSlimChunksDTO": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/GroupSlimChunksDTO"
+        }
+      },
+      "RecommendSlimChunkMetadata": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/SlimChunkMetadata"
+        }
+      },
       "RegenerateMessageData": {
         "type": "object",
         "required": [
@@ -5721,6 +5925,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": [
@@ -5762,7 +6004,7 @@
           "page": {
             "type": "integer",
             "format": "int64",
-            "description": "Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.",
+            "description": "Page of chunks to fetch. Page is 1-indexed.",
             "nullable": true,
             "minimum": 0
           },
@@ -5787,6 +6029,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.",
@@ -5804,10 +6051,10 @@
                   "value4"
                 ],
                 "range": {
-                  "gt": 0.0,
-                  "gte": 0.0,
-                  "lt": 1.0,
-                  "lte": 1.0
+                  "gt": 0,
+                  "gte": 0,
+                  "lt": 1,
+                  "lte": 1
                 }
               }
             ],
@@ -5819,10 +6066,10 @@
                   "value6"
                 ],
                 "range": {
-                  "gt": 0.0,
-                  "gte": 0.0,
-                  "lt": 1.0,
-                  "lte": 1.0
+                  "gt": 0,
+                  "gte": 0,
+                  "lt": 1,
+                  "lte": 1
                 }
               }
             ],
@@ -5834,10 +6081,10 @@
                   "value2"
                 ],
                 "range": {
-                  "gt": 0.0,
-                  "gte": 0.0,
-                  "lt": 1.0,
-                  "lte": 1.0
+                  "gt": 0,
+                  "gte": 0,
+                  "lt": 1,
+                  "lte": 1
                 }
               }
             ]
@@ -5877,6 +6124,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": [
@@ -5923,6 +6203,7 @@
           "group_size": {
             "type": "integer",
             "format": "int32",
+            "description": "Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization.",
             "nullable": true,
             "minimum": 0
           },
@@ -5942,14 +6223,14 @@
           "page": {
             "type": "integer",
             "format": "int64",
-            "description": "Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.",
+            "description": "Page of group results to fetch. Page is 1-indexed.",
             "nullable": true,
             "minimum": 0
           },
           "page_size": {
             "type": "integer",
             "format": "int32",
-            "description": "Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.",
+            "description": "Page size is the number of group results to fetch. The default is 10.",
             "nullable": true,
             "minimum": 0
           },
@@ -5966,6 +6247,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
           }
         }
       },
@@ -5988,6 +6274,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": [
@@ -6035,7 +6369,7 @@
           "page": {
             "type": "integer",
             "format": "int64",
-            "description": "The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.",
+            "description": "The page of chunks to fetch. Page is 1-indexed.",
             "nullable": true,
             "minimum": 0
           },
@@ -6060,6 +6394,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.",
@@ -6067,6 +6406,16 @@
           }
         }
       },
+      "SearchWithinGroupResponseTypes": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/SearchGroupsResult"
+          },
+          {
+            "$ref": "#/components/schemas/SearchGroupSlimChunksResult"
+          }
+        ]
+      },
       "SetUserApiKeyRequest": {
         "type": "object",
         "required": [
@@ -6140,6 +6489,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": [
@@ -6176,7 +6592,6 @@
         "required": [
           "id",
           "email",
-          "visible_email",
           "user_orgs",
           "orgs"
         ],
@@ -6203,17 +6618,6 @@
             "items": {
               "$ref": "#/components/schemas/UserOrganization"
             }
-          },
-          "username": {
-            "type": "string",
-            "nullable": true
-          },
-          "visible_email": {
-            "type": "boolean"
-          },
-          "website": {
-            "type": "string",
-            "nullable": true
           }
         },
         "example": {
@@ -6238,10 +6642,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": {
@@ -6486,6 +6887,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.",
@@ -6532,11 +6941,23 @@
             "description": "Id of the chunk_group to update.",
             "nullable": true
           },
+          "metadata": {
+            "description": "Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.",
+            "nullable": true
+          },
           "name": {
             "type": "string",
             "description": "Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated.",
             "nullable": true
           },
+          "tag_set": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.",
+            "nullable": true
+          },
           "tracking_id": {
             "type": "string",
             "description": "Tracking Id of the chunk_group to update.",
@@ -6587,11 +7008,23 @@
             "description": "Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. If not provided, the description will not be updated.",
             "nullable": true
           },
+          "metadata": {
+            "description": "Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group.",
+            "nullable": true
+          },
           "name": {
             "type": "string",
             "description": "Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated.",
             "nullable": true
           },
+          "tag_set": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group.",
+            "nullable": true
+          },
           "tracking_id": {
             "type": "string",
             "description": "Tracking Id of the chunk_group to update."
@@ -6661,21 +7094,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
           }
         }
       },
@@ -6850,7 +7268,7 @@
     },
     {
       "name": "events",
-      "description": "Notifications endpoint. Files are uploaded asynchronously and events are sent to the user when the upload is complete. Soon, chunk creation will work in the same way."
+      "description": "Notifications endpoint. Files are uploaded asynchronously and events are sent to the user when the upload is complete."
     },
     {
       "name": "topic",
@@ -6869,4 +7287,4 @@
       "description": "Health check endpoint. Used to check if the server is up and running."
     }
   ]
-}
+}