trieve_ruby_client 0.6.9 → 0.7.6

data/openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.6.9"
+    "version": "0.7.6"
   },
   "servers": [
     {
@@ -174,7 +174,7 @@
           "chunk"
         ],
         "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.",
+        "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.\nIf uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.",
         "operationId": "create_chunk",
         "parameters": [
           {
@@ -497,7 +497,7 @@
         ],
         "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><mark>` tags for sub-sentence highlighting.",
-        "operationId": "search_chunk",
+        "operationId": "search_chunks",
         "parameters": [
           {
             "name": "TR-Dataset",
@@ -664,6 +664,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Chunk not found"
           }
         },
         "security": [
@@ -774,6 +777,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Chunk not found"
           }
         },
         "security": [
@@ -1417,6 +1423,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found"
           }
         },
         "security": [
@@ -1476,6 +1485,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found"
           }
         },
         "security": [
@@ -1711,6 +1723,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found"
           }
         },
         "security": [
@@ -1843,6 +1858,134 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found"
+          }
+        },
+        "security": [
+          {
+            "ApiKey": [
+              "readonly"
+            ]
+          }
+        ]
+      }
+    },
+    "/api/chunks": {
+      "post": {
+        "tags": [
+          "chunk"
+        ],
+        "summary": "Get Chunks By Ids",
+        "description": "Get Chunks By Ids\n\nGet multiple chunks by multiple ids.",
+        "operationId": "get_chunks_by_ids",
+        "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 the chunks in the request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/GetChunksData"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "chunks with the id that you were searching for",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/ChunkMetadata"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Service error relating to fidning a chunk by tracking_id",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "ApiKey": [
+              "readonly"
+            ]
+          }
+        ]
+      }
+    },
+    "/api/chunks/tracking": {
+      "post": {
+        "tags": [
+          "chunk"
+        ],
+        "summary": "Get Chunks By TrackingIds",
+        "description": "Get Chunks By TrackingIds\n\nGet multiple chunks by ids.",
+        "operationId": "get_chunks_by_tracking_ids",
+        "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 the chunks in the request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/GetTrackingChunksData"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "chunk with the id that you were searching for",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ChunkMetadata"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Service error relating to fidning a chunk by tracking_id",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -2558,15 +2701,6 @@
               "type": "string",
               "format": "uuid"
             }
-          },
-          {
-            "name": "delete_chunks",
-            "in": "query",
-            "description": "Whether or not to delete the chunks associated with the file",
-            "required": true,
-            "schema": {
-              "type": "boolean"
-            }
           }
         ],
         "responses": {
@@ -3461,7 +3595,7 @@
           "topic"
         ],
         "summary": "Create Topic",
-        "description": "Create Topic\n\nCreate a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.",
+        "description": "Create Topic\n\nCreate a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions.",
         "operationId": "create_topic",
         "parameters": [
           {
@@ -3568,23 +3702,22 @@
         ]
       }
     },
-    "/api/topic/user/{user_id}": {
+    "/api/topic/owner/{owner_id}": {
       "get": {
         "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": "Get All Topics for Owner ID",
+        "description": "Get All Topics for Owner ID\n\nGet all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id.",
+        "operationId": "get_all_topics_for_owner_id",
         "parameters": [
           {
-            "name": "user_id",
+            "name": "owner_id",
             "in": "path",
-            "description": "The id of the user to get topics for",
+            "description": "The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id",
             "required": true,
             "schema": {
-              "type": "string",
-              "format": "uuid"
+              "type": "string"
             }
           },
           {
@@ -3599,7 +3732,7 @@
         ],
         "responses": {
           "200": {
-            "description": "All topics belonging to a given user",
+            "description": "All topics belonging to a given owner_id",
             "content": {
               "application/json": {
                 "schema": {
@@ -3612,7 +3745,7 @@
             }
           },
           "400": {
-            "description": "Service error relating to topic get",
+            "description": "Service error relating to getting topics for the owner_id",
             "content": {
               "application/json": {
                 "schema": {
@@ -3697,22 +3830,15 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/UpdateUserData"
+                "$ref": "#/components/schemas/UpdateUserOrgRoleData"
               }
             }
           },
           "required": true
         },
         "responses": {
-          "200": {
-            "description": "JSON body representing the updated user information",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/SlimUser"
-                }
-              }
-            }
+          "204": {
+            "description": "Confirmation that the user's role was updated"
           },
           "400": {
             "description": "Service error relating to updating the user",
@@ -4078,12 +4204,6 @@
             "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",
-            "description": "File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks.",
-            "nullable": true
-          },
           "group_ids": {
             "type": "array",
             "items": {
@@ -4106,6 +4226,14 @@
             "description": "Link to the chunk. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation.",
             "nullable": true
           },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            ],
+            "nullable": true
+          },
           "metadata": {
             "description": "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.",
             "nullable": true
@@ -4393,6 +4521,14 @@
             "type": "string",
             "nullable": true
           },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            ],
+            "nullable": true
+          },
           "metadata": {
             "nullable": true
           },
@@ -4532,7 +4668,8 @@
       "ClientDatasetConfiguration": {
         "type": "object",
         "required": [
-          "FILE_NAME_KEY"
+          "FILE_NAME_KEY",
+          "IMAGE_METADATA_KEY"
         ],
         "properties": {
           "CREATE_CHUNK_FEATURE": {
@@ -4557,6 +4694,9 @@
             "type": "string",
             "nullable": true
           },
+          "IMAGE_METADATA_KEY": {
+            "type": "string"
+          },
           "IMAGE_RANGE_END_KEY": {
             "type": "string",
             "nullable": true
@@ -4586,6 +4726,7 @@
           "FILE_NAME_KEY": "file_name_key",
           "FILTER_ITEMS": [],
           "FRONTMATTER_VALS": "frontmatter vals",
+          "IMAGE_METADATA_KEY": ".image_url",
           "IMAGE_RANGE_END_KEY": "image range end key",
           "IMAGE_RANGE_START_KEY": "image range start key",
           "LINES_BEFORE_SHOW_MORE": 10,
@@ -4760,11 +4901,6 @@
             "description": "The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`.",
             "nullable": true
           },
-          "model": {
-            "type": "string",
-            "description": "The model to use for the assistant's messages. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used.",
-            "nullable": true
-          },
           "new_message_content": {
             "type": "string",
             "description": "The content of the user message to attach to the topic and then generate an assistant message in response to."
@@ -4798,21 +4934,23 @@
       },
       "CreateTopicData": {
         "type": "object",
+        "required": [
+          "owner_id"
+        ],
         "properties": {
           "first_user_message": {
             "type": "string",
             "description": "The first message which will belong to the topic. The topic name is generated based on this message similar to how it works in the OpenAI chat UX if a name is not explicitly provided on the name request body key.",
             "nullable": true
           },
-          "model": {
-            "type": "string",
-            "description": "The model to use for the assistant's messages. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.",
-            "nullable": true
-          },
           "name": {
             "type": "string",
             "description": "The name of the topic. If this is not provided, the topic name is generated from the first_user_message.",
             "nullable": true
+          },
+          "owner_id": {
+            "type": "string",
+            "description": "The owner_id of the topic. This is typically a browser fingerprint or your user's id. It is used to group topics together for a user."
           }
         }
       },
@@ -5028,11 +5166,6 @@
             "format": "int32",
             "description": "The sort order of the message to edit."
           },
-          "model": {
-            "type": "string",
-            "description": "The model to use for the assistant generative inferences. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.~",
-            "nullable": true
-          },
           "new_message_content": {
             "type": "string",
             "description": "The new content of the message to replace the old content with."
@@ -5136,6 +5269,30 @@
             "type": "string",
             "description": "Field is the name of the field to filter on. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`."
           },
+          "geo_bounding_box": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/LocationBoundingBox"
+              }
+            ],
+            "nullable": true
+          },
+          "geo_polygon": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/LocationPolygon"
+              }
+            ],
+            "nullable": true
+          },
+          "geo_radius": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/LocationRadius"
+              }
+            ],
+            "nullable": true
+          },
           "match": {
             "type": "array",
             "items": {
@@ -5302,11 +5459,6 @@
             },
             "description": "The ids of the chunks to be retrieved and injected into the context window for RAG."
           },
-          "model": {
-            "type": "string",
-            "description": "The model to use for the chat. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used.",
-            "nullable": true
-          },
           "prev_messages": {
             "type": "array",
             "items": {
@@ -5340,6 +5492,48 @@
           "stream_response": true
         }
       },
+      "GeoInfo": {
+        "type": "object",
+        "required": [
+          "lat",
+          "lon"
+        ],
+        "properties": {
+          "lat": {
+            "$ref": "#/components/schemas/GeoTypes"
+          },
+          "lon": {
+            "$ref": "#/components/schemas/GeoTypes"
+          }
+        }
+      },
+      "GeoTypes": {
+        "oneOf": [
+          {
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "type": "number",
+            "format": "double"
+          }
+        ]
+      },
+      "GetChunksData": {
+        "type": "object",
+        "required": [
+          "ids"
+        ],
+        "properties": {
+          "ids": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        }
+      },
       "GetEventsData": {
         "type": "object",
         "properties": {
@@ -5348,7 +5542,7 @@
             "items": {
               "type": "string"
             },
-            "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.",
+            "description": "The types of events to get. Any combination of file_uploaded, chunk_uploaded, chunk_action_failed, chunk_updated, or qdrant_index_failed. Leave undefined to get all events.",
             "nullable": true
           },
           "page": {
@@ -5387,6 +5581,20 @@
           }
         }
       },
+      "GetTrackingChunksData": {
+        "type": "object",
+        "required": [
+          "tracking_ids"
+        ],
+        "properties": {
+          "tracking_ids": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
       "GroupData": {
         "type": "object",
         "required": [
@@ -5532,6 +5740,61 @@
           }
         }
       },
+      "LocationBoundingBox": {
+        "type": "object",
+        "required": [
+          "top_left",
+          "bottom_right"
+        ],
+        "properties": {
+          "bottom_right": {
+            "$ref": "#/components/schemas/GeoInfo"
+          },
+          "top_left": {
+            "$ref": "#/components/schemas/GeoInfo"
+          }
+        }
+      },
+      "LocationPolygon": {
+        "type": "object",
+        "required": [
+          "exterior"
+        ],
+        "properties": {
+          "exterior": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/GeoInfo"
+            }
+          },
+          "interior": {
+            "type": "array",
+            "items": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            },
+            "nullable": true
+          }
+        }
+      },
+      "LocationRadius": {
+        "type": "object",
+        "required": [
+          "center",
+          "radius"
+        ],
+        "properties": {
+          "center": {
+            "$ref": "#/components/schemas/GeoInfo"
+          },
+          "radius": {
+            "type": "number",
+            "format": "double"
+          }
+        }
+      },
       "MatchCondition": {
         "oneOf": [
           {
@@ -5748,6 +6011,10 @@
           {
             "type": "number",
             "format": "double"
+          },
+          {
+            "type": "integer",
+            "format": "int64"
           }
         ]
       },
@@ -5915,11 +6182,6 @@
             "description": "The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`.",
             "nullable": true
           },
-          "model": {
-            "type": "string",
-            "description": "The model to use for the assistant generative inferences. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.~",
-            "nullable": true
-          },
           "stream_response": {
             "type": "boolean",
             "description": "Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true.",
@@ -6518,6 +6780,7 @@
           "id",
           "created_at",
           "updated_at",
+          "dataset_id",
           "weight"
         ],
         "properties": {
@@ -6525,6 +6788,10 @@
             "type": "string",
             "format": "date-time"
           },
+          "dataset_id": {
+            "type": "string",
+            "format": "uuid"
+          },
           "id": {
             "type": "string",
             "format": "uuid"
@@ -6533,6 +6800,14 @@
             "type": "string",
             "nullable": true
           },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            ],
+            "nullable": true
+          },
           "metadata": {
             "nullable": true
           },
@@ -6844,12 +7119,12 @@
         "type": "object",
         "required": [
           "id",
-          "user_id",
           "name",
           "deleted",
           "created_at",
           "updated_at",
-          "dataset_id"
+          "dataset_id",
+          "owner_id"
         ],
         "properties": {
           "created_at": {
@@ -6870,13 +7145,12 @@
           "name": {
             "type": "string"
           },
+          "owner_id": {
+            "type": "string"
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
-          },
-          "user_id": {
-            "type": "string",
-            "format": "uuid"
           }
         },
         "example": {
@@ -6885,8 +7159,8 @@
           "deleted": false,
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
           "name": "Trieve",
-          "updated_at": "2021-01-01T00:00:00",
-          "user_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3"
+          "owner_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
+          "updated_at": "2021-01-01T00:00:00"
         }
       },
       "UpdateChunkByTrackingIdData": {
@@ -6989,6 +7263,14 @@
             "description": "Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used.",
             "nullable": true
           },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            ],
+            "nullable": true
+          },
           "metadata": {
             "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
@@ -7176,17 +7458,13 @@
           }
         }
       },
-      "UpdateUserData": {
+      "UpdateUserOrgRoleData": {
         "type": "object",
         "required": [
-          "organization_id"
+          "organization_id",
+          "role"
         ],
         "properties": {
-          "name": {
-            "type": "string",
-            "description": "In the sense of a legal name, not a username. The new name to assign to the user, if not provided, the current name will be used.",
-            "nullable": true
-          },
           "organization_id": {
             "type": "string",
             "format": "uuid",
@@ -7195,8 +7473,7 @@
           "role": {
             "type": "integer",
             "format": "int32",
-            "description": "Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned.",
-            "nullable": true
+            "description": "Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned."
           },
           "user_id": {
             "type": "string",