trieve_ruby_client 0.7.2 → 0.8.0

data/openapi.json

@@ -12,7 +12,7 @@
       "name": "BSL",
       "url": "https://github.com/devflowinc/trieve/blob/main/LICENSE.txt"
     },
-    "version": "0.7.2"
+    "version": "0.8.0"
   },
   "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,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Chunk not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -774,6 +784,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Chunk not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1417,6 +1437,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1476,6 +1506,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1711,6 +1751,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -1843,6 +1893,161 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Group not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
+          }
+        },
+        "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"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Any one of the specified chunks not found",
+            "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"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Any one of the specified chunks not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -2522,6 +2727,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "File not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -3179,6 +3394,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Organization not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponseBody"
+                }
+              }
+            }
           }
         },
         "security": [
@@ -4083,6 +4308,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
@@ -4370,6 +4603,14 @@
             "type": "string",
             "nullable": true
           },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            ],
+            "nullable": true
+          },
           "metadata": {
             "nullable": true
           },
@@ -4682,6 +4923,11 @@
             "type": "string",
             "description": "Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group.",
             "nullable": true
+          },
+          "upsert_by_tracking_id": {
+            "type": "boolean",
+            "description": "Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists.",
+            "nullable": true
           }
         }
       },
@@ -4742,11 +4988,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."
@@ -4789,11 +5030,6 @@
             "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.",
@@ -5017,11 +5253,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."
@@ -5125,6 +5356,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": {
@@ -5291,11 +5546,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": {
@@ -5329,6 +5579,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": {
@@ -5376,6 +5668,20 @@
           }
         }
       },
+      "GetTrackingChunksData": {
+        "type": "object",
+        "required": [
+          "tracking_ids"
+        ],
+        "properties": {
+          "tracking_ids": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
       "GroupData": {
         "type": "object",
         "required": [
@@ -5521,6 +5827,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": [
           {
@@ -5649,9 +6010,14 @@
           "dataset_count",
           "user_count",
           "file_storage",
-          "message_count"
+          "message_count",
+          "chunk_count"
         ],
         "properties": {
+          "chunk_count": {
+            "type": "integer",
+            "format": "int32"
+          },
           "dataset_count": {
             "type": "integer",
             "format": "int32"
@@ -5678,6 +6044,7 @@
           }
         },
         "example": {
+          "chunk_count": 1000,
           "dataset_count": 1,
           "file_storage": 512,
           "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
@@ -5737,6 +6104,10 @@
           {
             "type": "number",
             "format": "double"
+          },
+          {
+            "type": "integer",
+            "format": "int64"
           }
         ]
       },
@@ -5904,11 +6275,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.",
@@ -6030,6 +6396,11 @@
             "description": "Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.",
             "nullable": true
           },
+          "get_total_pages": {
+            "type": "boolean",
+            "description": "Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.",
+            "nullable": true
+          },
           "highlight_delimiters": {
             "type": "array",
             "items": {
@@ -6186,6 +6557,11 @@
             "description": "Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.",
             "nullable": true
           },
+          "get_total_pages": {
+            "type": "boolean",
+            "description": "Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.",
+            "nullable": true
+          },
           "group_size": {
             "type": "integer",
             "format": "int32",
@@ -6318,6 +6694,11 @@
             ],
             "nullable": true
           },
+          "get_total_pages": {
+            "type": "boolean",
+            "description": "Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.",
+            "nullable": true
+          },
           "group_id": {
             "type": "string",
             "format": "uuid",
@@ -6507,6 +6888,7 @@
           "id",
           "created_at",
           "updated_at",
+          "dataset_id",
           "weight"
         ],
         "properties": {
@@ -6514,6 +6896,10 @@
             "type": "string",
             "format": "date-time"
           },
+          "dataset_id": {
+            "type": "string",
+            "format": "uuid"
+          },
           "id": {
             "type": "string",
             "format": "uuid"
@@ -6522,6 +6908,14 @@
             "type": "string",
             "nullable": true
           },
+          "location": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/GeoInfo"
+              }
+            ],
+            "nullable": true
+          },
           "metadata": {
             "nullable": true
           },
@@ -6977,6 +7371,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