trieve_ruby_client 0.6.0 → 0.6.7

data/openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.6.0"
+    "version": "0.6.7"
   },
   "servers": [
     {
@@ -445,11 +445,27 @@
         },
         "responses": {
           "200": {
-            "description": "Chunks with embedding vectors which are similar to those in the request body",
+            "description": "Chunks with embedding vectors which are similar to positives and dissimilar to negatives if slim_chunks is false in the request",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/RecommendChunksResponseTypes"
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ChunkMetadataWithScore"
+                  }
+                }
+              }
+            }
+          },
+          "206": {
+            "description": "Chunks with embedding vectors which are similar to positives and dissimilar to negatives if slim_chunks is true in the request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/SlimChunkMetadataWithScore"
+                  }
                 }
               }
             }
@@ -480,7 +496,7 @@
           "chunk"
         ],
         "summary": "Search",
-        "description": "Search\n\nThis route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.",
+        "description": "Search\n\nThis route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.",
         "operationId": "search_chunk",
         "parameters": [
           {
@@ -506,11 +522,21 @@
         },
         "responses": {
           "200": {
-            "description": "Chunks with embedding vectors which are similar to those in the request body",
+            "description": "Chunks with embedding vectors which are similar to those in the request body if slim_chunks is false or not specified in the request body",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchChunkResponseTypes"
+                  "$ref": "#/components/schemas/SearchChunkQueryResponseBody"
+                }
+              }
+            }
+          },
+          "206": {
+            "description": "Chunks with embedding vectors which are similar to those in the request body if slim_chunks is true in the request body",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchSlimChunkQueryResponseBody"
                 }
               }
             }
@@ -1145,17 +1171,27 @@
         },
         "responses": {
           "200": {
-            "description": "Group chunks which are similar to the embedding vector of the search query",
+            "description": "Group chunks which are similar to the embedding vector of the search query if slim_chunks is false or unspecified in the request body",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchOverGroupsResults"
+                }
+              }
+            }
+          },
+          "206": {
+            "description": "Group chunks which are similar to the embedding vector of the search query if slim_chunks is true in the request body",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchOverGroupsResponseTypes"
+                  "$ref": "#/components/schemas/SearchOverGroupsSlimResults"
                 }
               }
             }
           },
           "400": {
-            "description": "Service error relating to getting the groups that the chunk is in",
+            "description": "Service error relating to searching over groups",
             "content": {
               "application/json": {
                 "schema": {
@@ -1206,11 +1242,27 @@
         },
         "responses": {
           "200": {
-            "description": "JSON body representing the groups which are similar to the groups in the request",
+            "description": "JSON body representing the groups which are similar to the positive groups and dissimilar to the negative ones if slim_chunks is false in the request",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/RecommendGroupChunkResponseTypes"
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/GroupScoreChunk"
+                  }
+                }
+              }
+            }
+          },
+          "206": {
+            "description": "JSON body representing the groups which are similar to the positive groups and dissimilar to the negative ones if slim_chunks is false in the request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/GroupScoreSlimChunks"
+                  }
                 }
               }
             }
@@ -1267,11 +1319,21 @@
         },
         "responses": {
           "200": {
-            "description": "Group chunks which are similar to the embedding vector of the search query",
+            "description": "Group chunks which are similar to the embedding vector of the search query if slim_chunks is false in the request",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchWithinGroupResponseTypes"
+                  "$ref": "#/components/schemas/SearchWithinGroupResults"
+                }
+              }
+            }
+          },
+          "206": {
+            "description": "Group chunks which are similar to the embedding vector of the search query if slim_chunks is true in the request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchWithinGroupSlimResults"
                 }
               }
             }
@@ -3672,36 +3734,32 @@
         ]
       }
     },
-    "/api/user/delete_api_key/{api_key_id}": {
-      "delete": {
+    "/api/user/api_key": {
+      "post": {
         "tags": [
           "user"
         ],
-        "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",
-        "parameters": [
-          {
-            "name": "api_key_id",
-            "in": "path",
-            "description": "The id of the api key to delete",
-            "required": true,
-            "schema": {
-              "type": "string",
-              "format": "uuid"
+        "summary": "Set User Api Key",
+        "description": "Set User Api Key\n\nCreate a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.",
+        "operationId": "set_user_api_key",
+        "requestBody": {
+          "description": "JSON request payload to create a new user api key",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SetUserApiKeyRequest"
+              }
             }
-          }
-        ],
+          },
+          "required": true
+        },
         "responses": {
           "200": {
             "description": "JSON body representing the api_key for the user",
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/ApiKeyDTO"
-                  }
+                  "$ref": "#/components/schemas/SetUserApiKeyResponse"
                 }
               }
             }
@@ -3726,32 +3784,36 @@
         ]
       }
     },
-    "/api/user/set_api_key": {
-      "post": {
+    "/api/user/api_key/{api_key_id}": {
+      "delete": {
         "tags": [
           "user"
         ],
-        "summary": "Set User Api Key",
-        "description": "Set User Api Key\n\nCreate a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.",
-        "operationId": "set_user_api_key",
-        "requestBody": {
-          "description": "JSON request payload to create a new user api key",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/SetUserApiKeyRequest"
-              }
+        "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",
+        "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",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SetUserApiKeyResponse"
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ApiKeyDTO"
+                  }
                 }
               }
             }
@@ -3944,7 +4006,7 @@
           "chunks": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ChunkMetadataWithFileData"
+              "$ref": "#/components/schemas/ChunkMetadata"
             }
           },
           "group": {
@@ -4011,6 +4073,11 @@
             "description": "Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
+            "nullable": true
+          },
           "file_id": {
             "type": "string",
             "format": "uuid",
@@ -4374,15 +4441,16 @@
           "weight": 0.5
         }
       },
-      "ChunkMetadataWithFileData": {
+      "ChunkMetadataWithScore": {
         "type": "object",
         "required": [
           "id",
           "content",
-          "qdrant_point_id",
           "created_at",
           "updated_at",
-          "weight"
+          "dataset_id",
+          "weight",
+          "score"
         ],
         "properties": {
           "chunk_html": {
@@ -4396,14 +4464,9 @@
             "type": "string",
             "format": "date-time"
           },
-          "file_id": {
-            "type": "string",
-            "format": "uuid",
-            "nullable": true
-          },
-          "file_name": {
+          "dataset_id": {
             "type": "string",
-            "nullable": true
+            "format": "uuid"
           },
           "id": {
             "type": "string",
@@ -4418,7 +4481,12 @@
           },
           "qdrant_point_id": {
             "type": "string",
-            "format": "uuid"
+            "format": "uuid",
+            "nullable": true
+          },
+          "score": {
+            "type": "number",
+            "format": "float"
           },
           "tag_set": {
             "type": "string",
@@ -4446,14 +4514,14 @@
           "chunk_html": "<p>Hello, world!</p>",
           "content": "Hello, world!",
           "created_at": "2021-01-01T00:00:00",
-          "file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
-          "file_name": "file.txt",
+          "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",
+          "score": 0.9,
           "tag_set": "tag1,tag2",
           "time_stamp": "2021-01-01T00:00:00",
           "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
@@ -4604,13 +4672,13 @@
       "CreateChunkGroupData": {
         "type": "object",
         "required": [
-          "name",
-          "description"
+          "name"
         ],
         "properties": {
           "description": {
             "type": "string",
-            "description": "Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for."
+            "description": "Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for.",
+            "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.",
@@ -5265,7 +5333,7 @@
             "items": {
               "type": "string"
             },
-            "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.",
+            "description": "The types of events to get. Any combination of file_uploaded, chunk_uploaded, chunk_action_failed, or chunk_updated. Leave undefined to get all events.",
             "nullable": true
           },
           "page": {
@@ -5285,7 +5353,7 @@
           "page": 1,
           "page_size": 10,
           "type": [
-            "card_action_failed"
+            "chunk_action_failed"
           ]
         }
       },
@@ -5323,7 +5391,7 @@
           }
         }
       },
-      "GroupScoreChunkDTO": {
+      "GroupScoreChunk": {
         "type": "object",
         "required": [
           "group_id",
@@ -5334,6 +5402,10 @@
             "type": "string",
             "format": "uuid"
           },
+          "group_name": {
+            "type": "string",
+            "nullable": true
+          },
           "group_tracking_id": {
             "type": "string",
             "nullable": true
@@ -5368,7 +5440,7 @@
           ]
         }
       },
-      "GroupSlimChunksDTO": {
+      "GroupScoreSlimChunks": {
         "type": "object",
         "required": [
           "group_id",
@@ -5664,12 +5736,6 @@
           }
         ]
       },
-      "RecommendChunkMetadata": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/ChunkMetadata"
-        }
-      },
       "RecommendChunksRequest": {
         "type": "object",
         "properties": {
@@ -5734,32 +5800,6 @@
           }
         }
       },
-      "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": {
@@ -5831,18 +5871,6 @@
           }
         }
       },
-      "RecommendGroupSlimChunksDTO": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/GroupSlimChunksDTO"
-        }
-      },
-      "RecommendSlimChunkMetadata": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/SlimChunkMetadata"
-        }
-      },
       "RegenerateMessageData": {
         "type": "object",
         "required": [
@@ -5899,7 +5927,7 @@
           "metadata": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ChunkMetadataWithFileData"
+              "$ref": "#/components/schemas/ChunkMetadata"
             }
           },
           "score": {
@@ -6124,62 +6152,6 @@
           }
         }
       },
-      "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": [
-          "bookmarks",
-          "group",
-          "total_pages"
-        ],
-        "properties": {
-          "bookmarks": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/ScoreChunkDTO"
-            }
-          },
-          "group": {
-            "$ref": "#/components/schemas/ChunkGroup"
-          },
-          "total_pages": {
-            "type": "integer",
-            "format": "int64"
-          }
-        }
-      },
       "SearchOverGroupsData": {
         "type": "object",
         "required": [
@@ -6255,7 +6227,7 @@
           }
         }
       },
-      "SearchOverGroupsResponseBody": {
+      "SearchOverGroupsResults": {
         "type": "object",
         "required": [
           "group_chunks",
@@ -6265,7 +6237,7 @@
           "group_chunks": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/GroupScoreChunkDTO"
+              "$ref": "#/components/schemas/GroupScoreChunk"
             }
           },
           "total_chunk_pages": {
@@ -6274,17 +6246,7 @@
           }
         }
       },
-      "SearchOverGroupsResponseTypes": {
-        "oneOf": [
-          {
-            "$ref": "#/components/schemas/SearchOverGroupsResponseBody"
-          },
-          {
-            "$ref": "#/components/schemas/SearchOverGroupsSlimChunksResponseBody"
-          }
-        ]
-      },
-      "SearchOverGroupsSlimChunksResponseBody": {
+      "SearchOverGroupsSlimResults": {
         "type": "object",
         "required": [
           "group_chunks",
@@ -6294,7 +6256,7 @@
           "group_chunks": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/GroupSlimChunksDTO"
+              "$ref": "#/components/schemas/GroupScoreSlimChunks"
             }
           },
           "total_chunk_pages": {
@@ -6406,15 +6368,51 @@
           }
         }
       },
-      "SearchWithinGroupResponseTypes": {
-        "oneOf": [
-          {
-            "$ref": "#/components/schemas/SearchGroupsResult"
+      "SearchWithinGroupResults": {
+        "type": "object",
+        "required": [
+          "bookmarks",
+          "group",
+          "total_pages"
+        ],
+        "properties": {
+          "bookmarks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ScoreChunkDTO"
+            }
           },
-          {
-            "$ref": "#/components/schemas/SearchGroupSlimChunksResult"
+          "group": {
+            "$ref": "#/components/schemas/ChunkGroup"
+          },
+          "total_pages": {
+            "type": "integer",
+            "format": "int64"
           }
-        ]
+        }
+      },
+      "SearchWithinGroupSlimResults": {
+        "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"
+          }
+        }
       },
       "SetUserApiKeyRequest": {
         "type": "object",
@@ -6556,6 +6554,79 @@
           "weight": 0.5
         }
       },
+      "SlimChunkMetadataWithScore": {
+        "type": "object",
+        "required": [
+          "id",
+          "created_at",
+          "updated_at",
+          "weight",
+          "score"
+        ],
+        "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
+          },
+          "score": {
+            "type": "number",
+            "format": "float"
+          },
+          "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",
+          "score": 0.9,
+          "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": [
@@ -6804,6 +6875,11 @@
             "description": "HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
+            "nullable": true
+          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -6861,6 +6937,11 @@
             "description": "Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.",
             "nullable": true
           },
+          "convert_html_to_text": {
+            "type": "boolean",
+            "description": "Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.",
+            "nullable": true
+          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -7101,8 +7182,7 @@
         "type": "object",
         "required": [
           "base64_file",
-          "file_name",
-          "file_mime_type"
+          "file_name"
         ],
         "properties": {
           "base64_file": {
@@ -7119,14 +7199,15 @@
             "description": "Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.",
             "nullable": true
           },
-          "file_mime_type": {
-            "type": "string",
-            "description": "MIME type of the file being uploaded."
-          },
           "file_name": {
             "type": "string",
             "description": "Name of the file being uploaded, including the extension."
           },
+          "group_tracking_id": {
+            "type": "string",
+            "description": "Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>`",
+            "nullable": true
+          },
           "link": {
             "type": "string",
             "description": "Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.",