trieve_ruby_client 0.3.4

data/docs/SearchChunkData.md

@@ -0,0 +1,38 @@
+# TrieveRubyClient::SearchChunkData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_bias** | **Boolean** | Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. | [optional] |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **get_collisions** | **Boolean** | 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. | [optional] |
+| **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
+| **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
+| **page** | **Integer** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
+| **page_size** | **Integer** | 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** | 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. |  |
+| **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
+| **search_type** | **String** | 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. |  |
+| **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
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchChunkData.new(
+  date_bias: null,
+  filters: null,
+  get_collisions: null,
+  highlight_delimiters: null,
+  highlight_results: null,
+  page: null,
+  page_size: null,
+  query: null,
+  score_threshold: null,
+  search_type: null,
+  use_weights: null
+)
+```
+

data/docs/SearchChunkQueryResponseBody.md

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

data/docs/SearchGroupsResult.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::SearchGroupsResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bookmarks** | [**Array<ScoreChunkDTO>**](ScoreChunkDTO.md) |  |  |
+| **group** | [**ChunkGroup**](ChunkGroup.md) |  |  |
+| **total_pages** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchGroupsResult.new(
+  bookmarks: null,
+  group: null,
+  total_pages: null
+)
+```
+

data/docs/SearchOverGroupsData.md

@@ -0,0 +1,36 @@
+# TrieveRubyClient::SearchOverGroupsData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **get_collisions** | **Boolean** | 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. | [optional] |
+| **group_size** | **Integer** |  | [optional] |
+| **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
+| **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
+| **page** | **Integer** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
+| **page_size** | **Integer** | 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** | 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. |  |
+| **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
+| **search_type** | **String** | 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. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchOverGroupsData.new(
+  filters: null,
+  get_collisions: null,
+  group_size: null,
+  highlight_delimiters: null,
+  highlight_results: null,
+  page: null,
+  page_size: null,
+  query: null,
+  score_threshold: null,
+  search_type: null
+)
+```
+

data/docs/SearchOverGroupsResponseBody.md

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

data/docs/SearchWithinGroupData.md

@@ -0,0 +1,40 @@
+# TrieveRubyClient::SearchWithinGroupData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_bias** | **Boolean** | Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. | [optional] |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **group_id** | **String** | Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group. | [optional] |
+| **group_tracking_id** | **String** | Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used. | [optional] |
+| **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
+| **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
+| **page** | **Integer** | The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [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. |  |
+| **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. |  |
+| **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
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchWithinGroupData.new(
+  date_bias: null,
+  filters: null,
+  group_id: null,
+  group_tracking_id: null,
+  highlight_delimiters: null,
+  highlight_results: null,
+  page: null,
+  page_size: null,
+  query: null,
+  score_threshold: null,
+  search_type: null,
+  use_weights: null
+)
+```
+

data/docs/SetUserApiKeyRequest.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::SetUserApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name which will be assigned to the new api key. |  |
+| **role** | **Integer** | The role which will be assigned to the new api key. Either 0 (read), 1 (read and write at the level of the currently auth'ed user). The auth'ed user must have a role greater than or equal to the role being assigned which means they must be an admin (1) or owner (2) of the organization to assign write permissions with a role of 1. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SetUserApiKeyRequest.new(
+  name: null,
+  role: null
+)
+```
+

data/docs/SetUserApiKeyResponse.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::SetUserApiKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key** | **String** | The api key which was created. This is the value which should be used in the Authorization header. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SetUserApiKeyResponse.new(
+  api_key: null
+)
+```
+

data/docs/SlimGroup.md

@@ -0,0 +1,24 @@
+# TrieveRubyClient::SlimGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **of_current_dataset** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SlimGroup.new(
+  dataset_id: null,
+  id: null,
+  name: null,
+  of_current_dataset: null
+)
+```
+

data/docs/SlimUser.md

@@ -0,0 +1,32 @@
+# TrieveRubyClient::SlimUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **orgs** | [**Array<Organization>**](Organization.md) |  |  |
+| **user_orgs** | [**Array<UserOrganization>**](UserOrganization.md) |  |  |
+| **username** | **String** |  | [optional] |
+| **visible_email** | **Boolean** |  |  |
+| **website** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SlimUser.new(
+  email: null,
+  id: null,
+  name: null,
+  orgs: null,
+  user_orgs: null,
+  username: null,
+  visible_email: null,
+  website: null
+)
+```
+

data/docs/StripeApi.md

@@ -0,0 +1,285 @@
+# TrieveRubyClient::StripeApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} |  |
+| [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} |  |
+| [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans |  |
+| [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} |  |
+
+
+## cancel_subscription
+
+> cancel_subscription(tr_organization, subscription_id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Cookie'] = 'Bearer'
+
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = TrieveRubyClient::StripeApi.new
+tr_organization = 'tr_organization_example' # String | The organization id to use for the request
+subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the subscription you want to cancel
+
+begin
+  
+  api_instance.cancel_subscription(tr_organization, subscription_id)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->cancel_subscription: #{e}"
+end
+```
+
+#### Using the cancel_subscription_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> cancel_subscription_with_http_info(tr_organization, subscription_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.cancel_subscription_with_http_info(tr_organization, subscription_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->cancel_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_organization** | **String** | The organization id to use for the request |  |
+| **subscription_id** | **String** | id of the subscription you want to cancel |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## direct_to_payment_link
+
+> direct_to_payment_link(plan_id, organization_id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::StripeApi.new
+plan_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the plan you want to subscribe to
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the organization you want to subscribe to the plan
+
+begin
+  
+  api_instance.direct_to_payment_link(plan_id, organization_id)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->direct_to_payment_link: #{e}"
+end
+```
+
+#### Using the direct_to_payment_link_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> direct_to_payment_link_with_http_info(plan_id, organization_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.direct_to_payment_link_with_http_info(plan_id, organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->direct_to_payment_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_id** | **String** | id of the plan you want to subscribe to |  |
+| **organization_id** | **String** | id of the organization you want to subscribe to the plan |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_all_plans
+
+> <Array<StripePlan>> get_all_plans
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::StripeApi.new
+
+begin
+  
+  result = api_instance.get_all_plans
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->get_all_plans: #{e}"
+end
+```
+
+#### Using the get_all_plans_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<StripePlan>>, Integer, Hash)> get_all_plans_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_all_plans_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<StripePlan>>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->get_all_plans_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;StripePlan&gt;**](StripePlan.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_subscription_plan
+
+> update_subscription_plan(tr_organization, subscription_id, plan_id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Cookie'] = 'Bearer'
+
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = TrieveRubyClient::StripeApi.new
+tr_organization = 'tr_organization_example' # String | The organization id to use for the request
+subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the subscription you want to update
+plan_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the plan you want to subscribe to
+
+begin
+  
+  api_instance.update_subscription_plan(tr_organization, subscription_id, plan_id)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->update_subscription_plan: #{e}"
+end
+```
+
+#### Using the update_subscription_plan_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->update_subscription_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_organization** | **String** | The organization id to use for the request |  |
+| **subscription_id** | **String** | id of the subscription you want to update |  |
+| **plan_id** | **String** | id of the plan you want to subscribe to |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/StripePlan.md

@@ -0,0 +1,38 @@
+# TrieveRubyClient::StripePlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  |  |
+| **chunk_count** | **Integer** |  |  |
+| **created_at** | **Time** |  |  |
+| **dataset_count** | **Integer** |  |  |
+| **file_storage** | **Integer** |  |  |
+| **id** | **String** |  |  |
+| **message_count** | **Integer** |  |  |
+| **name** | **String** |  |  |
+| **stripe_id** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+| **user_count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::StripePlan.new(
+  amount: null,
+  chunk_count: null,
+  created_at: null,
+  dataset_count: null,
+  file_storage: null,
+  id: null,
+  message_count: null,
+  name: null,
+  stripe_id: null,
+  updated_at: null,
+  user_count: null
+)
+```
+

data/docs/StripeSubscription.md

@@ -0,0 +1,30 @@
+# TrieveRubyClient::StripeSubscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **current_period_end** | **Time** |  | [optional] |
+| **id** | **String** |  |  |
+| **organization_id** | **String** |  |  |
+| **plan_id** | **String** |  |  |
+| **stripe_id** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::StripeSubscription.new(
+  created_at: null,
+  current_period_end: null,
+  id: null,
+  organization_id: null,
+  plan_id: null,
+  stripe_id: null,
+  updated_at: null
+)
+```
+

data/docs/SuggestedQueriesRequest.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::SuggestedQueriesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | The query to base the generated suggested queries off of. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SuggestedQueriesRequest.new(
+  query: null
+)
+```
+

data/docs/SuggestedQueriesResponse.md

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