trieve_ruby_client 0.10.7 → 0.11.0

data/docs/SearchOverGroupsResponseBody.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **group_chunks** | [**Array<GroupScoreChunkDTO>**](GroupScoreChunkDTO.md) |  |  |
-| **total_chunk_pages** | **Integer** |  |  |
+| **results** | [**Array<SearchOverGroupsResults>**](SearchOverGroupsResults.md) |  |  |
+| **total_pages** | **Integer** |  |  |
 
 ## Example
 
@@ -13,8 +13,8 @@
 require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::SearchOverGroupsResponseBody.new(
-  group_chunks: null,
-  total_chunk_pages: null
+  results: null,
+  total_pages: null
 )
 ```
 

data/docs/SearchOverGroupsResponseTypes.md

@@ -14,8 +14,8 @@ require 'trieve_ruby_client'
 TrieveRubyClient::SearchOverGroupsResponseTypes.openapi_one_of
 # =>
 # [
-#   :'SearchOverGroupsResponseBody',
-#   :'SearchOverGroupsSlimChunksResponseBody'
+#   :'DeprecatedSearchOverGroupsResponseBody',
+#   :'SearchOverGroupsResponseBody'
 # ]
 ```
 
@@ -29,7 +29,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 require 'trieve_ruby_client'
 
 TrieveRubyClient::SearchOverGroupsResponseTypes.build(data)
-# => #<SearchOverGroupsResponseBody:0x00007fdd4aab02a0>
+# => #<DeprecatedSearchOverGroupsResponseBody:0x00007fdd4aab02a0>
 
 TrieveRubyClient::SearchOverGroupsResponseTypes.build(data_that_doesnt_match)
 # => nil
@@ -43,7 +43,7 @@ TrieveRubyClient::SearchOverGroupsResponseTypes.build(data_that_doesnt_match)
 
 #### Return type
 
+- `DeprecatedSearchOverGroupsResponseBody`
 - `SearchOverGroupsResponseBody`
-- `SearchOverGroupsSlimChunksResponseBody`
 - `nil` (if no type matches)
 

data/docs/SearchOverGroupsResults.md

@@ -4,8 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **group_chunks** | [**Array<GroupScoreChunk>**](GroupScoreChunk.md) |  |  |
-| **total_chunk_pages** | **Integer** |  |  |
+| **chunks** | [**Array<ScoreChunk>**](ScoreChunk.md) |  |  |
+| **file_id** | **String** |  | [optional] |
+| **group** | [**ChunkGroup**](ChunkGroup.md) |  |  |
 
 ## Example
 
@@ -13,8 +14,9 @@
 require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::SearchOverGroupsResults.new(
-  group_chunks: null,
-  total_chunk_pages: null
+  chunks: null,
+  file_id: null,
+  group: null
 )
 ```
 

data/docs/SearchQueries.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::SearchQueries
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**SearchAnalyticsFilter**](SearchAnalyticsFilter.md) |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **sort_by** | [**SortBy**](SortBy.md) |  | [optional] |
+| **sort_order** | [**SortOrder**](SortOrder.md) |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchQueries.new(
+  filter: null,
+  page: null,
+  sort_by: null,
+  sort_order: null,
+  type: null
+)
+```
+

data/docs/SearchQueryEvent.md

@@ -0,0 +1,34 @@
+# TrieveRubyClient::SearchQueryEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **latency** | **Float** |  |  |
+| **query** | **String** |  |  |
+| **request_params** | **String** |  |  |
+| **results** | [**Array<SearchResultType>**](SearchResultType.md) |  |  |
+| **search_type** | **String** |  |  |
+| **top_score** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchQueryEvent.new(
+  created_at: null,
+  dataset_id: null,
+  id: null,
+  latency: null,
+  query: null,
+  request_params: null,
+  results: null,
+  search_type: null,
+  top_score: null
+)
+```
+

data/docs/SearchQueryResponse.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::SearchQueryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **queries** | [**Array<SearchQueryEvent>**](SearchQueryEvent.md) |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchQueryResponse.new(
+  queries: null
+)
+```
+

data/docs/SearchRPSGraph.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::SearchRPSGraph
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **average_rps** | **Float** |  |  |
+| **time_stamp** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchRPSGraph.new(
+  average_rps: null,
+  time_stamp: null
+)
+```
+

data/docs/SearchResponseBody.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::SearchResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunks** | [**Array<ScoreChunk>**](ScoreChunk.md) |  |  |
+| **total_pages** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchResponseBody.new(
+  chunks: null,
+  total_pages: null
+)
+```
+

data/docs/SearchResponseTypes.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::SearchResponseTypes
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::SearchResponseTypes.openapi_one_of
+# =>
+# [
+#   :'SearchChunkQueryResponseBody',
+#   :'SearchResponseBody'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::SearchResponseTypes.build(data)
+# => #<SearchChunkQueryResponseBody:0x00007fdd4aab02a0>
+
+TrieveRubyClient::SearchResponseTypes.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SearchChunkQueryResponseBody`
+- `SearchResponseBody`
+- `nil` (if no type matches)
+

data/docs/SearchResultType.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::SearchResultType
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::SearchResultType.openapi_one_of
+# =>
+# [
+#   :'GroupScoreChunk',
+#   :'ScoreChunkDTO'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::SearchResultType.build(data)
+# => #<GroupScoreChunk:0x00007fdd4aab02a0>
+
+TrieveRubyClient::SearchResultType.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `GroupScoreChunk`
+- `ScoreChunkDTO`
+- `nil` (if no type matches)
+

data/docs/SearchType.md

@@ -0,0 +1,15 @@
+# TrieveRubyClient::SearchType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchType.new()
+```
+

data/docs/SearchTypeCount.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::SearchTypeCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_count** | **Integer** |  |  |
+| **search_method** | **String** |  |  |
+| **search_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchTypeCount.new(
+  search_count: null,
+  search_method: null,
+  search_type: null
+)
+```
+

data/docs/SearchWithinGroupData.md

@@ -14,14 +14,16 @@
 | **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>` tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response. | [optional] |
 | **highlight_threshold** | **Float** | Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0. | [optional] |
 | **highlight_window** | **Integer** | Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response's highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once. | [optional] |
+| **location_bias** | [**GeoInfoWithBias**](GeoInfoWithBias.md) |  | [optional] |
 | **page** | **Integer** | The page of chunks to fetch. Page is 1-indexed. | [optional] |
 | **page_size** | **Integer** | The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
 | **query** | **String** | The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. |  |
 | **recency_bias** | **Float** | Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. | [optional] |
-| **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
-| **search_type** | **String** | 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. |  |
+| **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0. | [optional] |
+| **search_type** | [**SearchMethod**](SearchMethod.md) |  |  |
 | **slim_chunks** | **Boolean** | 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 (typicall 10-50ms). Default is false. | [optional] |
 | **tag_weights** | **Hash<String, Float>** | Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights. | [optional] |
+| **use_reranker** | **Boolean** | If true, chunks will be reranked using scores from a cross encoder model. \"hybrid\" search will always use the reranker regardless of this setting. | [optional] |
 | **use_weights** | **Boolean** | 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. | [optional] |
 
 ## Example
@@ -40,6 +42,7 @@ instance = TrieveRubyClient::SearchWithinGroupData.new(
   highlight_results: null,
   highlight_threshold: null,
   highlight_window: null,
+  location_bias: null,
   page: null,
   page_size: null,
   query: null,
@@ -48,6 +51,7 @@ instance = TrieveRubyClient::SearchWithinGroupData.new(
   search_type: null,
   slim_chunks: null,
   tag_weights: null,
+  use_reranker: null,
   use_weights: null
 )
 ```

data/docs/SearchWithinGroupResponseBody.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::SearchWithinGroupResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunks** | [**Array<ScoreChunk>**](ScoreChunk.md) |  |  |
+| **total_pages** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchWithinGroupResponseBody.new(
+  chunks: null,
+  total_pages: null
+)
+```
+

data/docs/SearchWithinGroupResults.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **bookmarks** | [**Array<ScoreChunkDTO>**](ScoreChunkDTO.md) |  |  |
-| **group** | [**ChunkGroup**](ChunkGroup.md) |  |  |
+| **group** | [**ChunkGroupAndFileId**](ChunkGroupAndFileId.md) |  |  |
 | **total_pages** | **Integer** |  |  |
 
 ## Example

data/docs/SlimChunkMetadata.md

@@ -12,7 +12,7 @@
 | **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
 | **num_value** | **Float** |  | [optional] |
-| **qdrant_point_id** | **String** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
 | **tag_set** | **String** |  | [optional] |
 | **time_stamp** | **Time** |  | [optional] |
 | **tracking_id** | **String** |  | [optional] |

data/docs/SlimChunkMetadataWithArrayTagSet.md

@@ -0,0 +1,44 @@
+# TrieveRubyClient::SlimChunkMetadataWithArrayTagSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
+| **link** | **String** |  | [optional] |
+| **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
+| **tag_set** | **Array<String>** |  | [optional] |
+| **time_stamp** | **Time** |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+| **weight** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SlimChunkMetadataWithArrayTagSet.new(
+  created_at: null,
+  dataset_id: null,
+  id: null,
+  image_urls: null,
+  link: null,
+  location: null,
+  metadata: null,
+  num_value: null,
+  qdrant_point_id: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  updated_at: null,
+  weight: null
+)
+```
+

data/docs/SlimChunkMetadataWithScore.md

@@ -8,7 +8,7 @@
 | **id** | **String** |  |  |
 | **link** | **String** |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
-| **qdrant_point_id** | **String** |  | [optional] |
+| **qdrant_point_id** | **String** |  |  |
 | **score** | **Float** |  |  |
 | **tag_set** | **String** |  | [optional] |
 | **time_stamp** | **Time** |  | [optional] |

data/docs/SortBy.md

@@ -0,0 +1,15 @@
+# TrieveRubyClient::SortBy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SortBy.new()
+```
+

data/docs/SortOrder.md

@@ -0,0 +1,15 @@
+# TrieveRubyClient::SortOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SortOrder.new()
+```
+

data/docs/StripeApi.md

@@ -5,7 +5,9 @@ All URIs are relative to *https://api.trieve.ai*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription |
+| [**create_setup_checkout_session**](StripeApi.md#create_setup_checkout_session) | **POST** /api/stripe/checkout/setup/{organization_id} | Create checkout session setup |
 | [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout |
+| [**get_all_invoices**](StripeApi.md#get_all_invoices) | **GET** /api/stripe/invoices/{organization_id} | Get All Invoices |
 | [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans |
 | [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan |
 
@@ -16,7 +18,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Cancel Subscription
 
-Cancel Subscription  Cancel a subscription by its id
+Cancel a subscription by its id
 
 ### Examples
 
@@ -82,13 +84,77 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## create_setup_checkout_session
+
+> <CreateSetupCheckoutSessionResPayload> create_setup_checkout_session(organization_id)
+
+Create checkout session setup
+
+Create a checkout session (setup)
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::StripeApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization to create setup checkout session for.
+
+begin
+  # Create checkout session setup
+  result = api_instance.create_setup_checkout_session(organization_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->create_setup_checkout_session: #{e}"
+end
+```
+
+#### Using the create_setup_checkout_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSetupCheckoutSessionResPayload>, Integer, Hash)> create_setup_checkout_session_with_http_info(organization_id)
+
+```ruby
+begin
+  # Create checkout session setup
+  data, status_code, headers = api_instance.create_setup_checkout_session_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSetupCheckoutSessionResPayload>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->create_setup_checkout_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** | The id of the organization to create setup checkout session for. |  |
+
+### Return type
+
+[**CreateSetupCheckoutSessionResPayload**](CreateSetupCheckoutSessionResPayload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## direct_to_payment_link
 
 > direct_to_payment_link(plan_id, organization_id)
 
 Checkout
 
-Checkout  Get a direct link to the stripe checkout page for the plan and organization
+Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization
 
 ### Examples
 
@@ -147,13 +213,77 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_all_invoices
+
+> <Array<StripeInvoice>> get_all_invoices(organization_id)
+
+Get All Invoices
+
+Get a list of all invoices
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::StripeApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization to get invoices for.
+
+begin
+  # Get All Invoices
+  result = api_instance.get_all_invoices(organization_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->get_all_invoices: #{e}"
+end
+```
+
+#### Using the get_all_invoices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<StripeInvoice>>, Integer, Hash)> get_all_invoices_with_http_info(organization_id)
+
+```ruby
+begin
+  # Get All Invoices
+  data, status_code, headers = api_instance.get_all_invoices_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<StripeInvoice>>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->get_all_invoices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** | The id of the organization to get invoices for. |  |
+
+### Return type
+
+[**Array&lt;StripeInvoice&gt;**](StripeInvoice.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_all_plans
 
 > <Array<StripePlan>> get_all_plans
 
 Get All Plans
 
-Get All Plans  Get a list of all plans
+Get a list of all plans
 
 ### Examples
 
@@ -214,7 +344,7 @@ No authorization required
 
 Update Subscription Plan
 
-Update Subscription Plan  Update a subscription to a new plan
+Update a subscription to a new plan
 
 ### Examples