trieve_ruby_client 0.8.2 → 0.11.0

data/docs/AnalyticsApi.md

@@ -0,0 +1,303 @@
+# TrieveRubyClient::AnalyticsApi
+
+All URIs are relative to *https://api.trieve.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_cluster_analytics**](AnalyticsApi.md#get_cluster_analytics) | **POST** /api/analytics/search/cluster | Get Cluster Analytics |
+| [**get_rag_analytics**](AnalyticsApi.md#get_rag_analytics) | **POST** /api/analytics/rag | Get RAG Analytics |
+| [**get_recommendation_analytics**](AnalyticsApi.md#get_recommendation_analytics) | **POST** /api/analytics/recommendation | Get Recommendation Analytics |
+| [**get_search_analytics**](AnalyticsApi.md#get_search_analytics) | **POST** /api/analytics/search | Get Search Analytics |
+
+
+## get_cluster_analytics
+
+> <ClusterAnalyticsResponse> get_cluster_analytics(tr_dataset, cluster_analytics)
+
+Get Cluster Analytics
+
+This route allows you to view the cluster analytics for a dataset.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # 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::AnalyticsApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+cluster_analytics = TrieveRubyClient::ClusterQueries.new({cluster_id: 'cluster_id_example', type: 'cluster_queries'}) # ClusterAnalytics | JSON request payload to filter the graph
+
+begin
+  # Get Cluster Analytics
+  result = api_instance.get_cluster_analytics(tr_dataset, cluster_analytics)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_cluster_analytics: #{e}"
+end
+```
+
+#### Using the get_cluster_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClusterAnalyticsResponse>, Integer, Hash)> get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics)
+
+```ruby
+begin
+  # Get Cluster Analytics
+  data, status_code, headers = api_instance.get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClusterAnalyticsResponse>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_cluster_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **cluster_analytics** | [**ClusterAnalytics**](ClusterAnalytics.md) | JSON request payload to filter the graph |  |
+
+### Return type
+
+[**ClusterAnalyticsResponse**](ClusterAnalyticsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_rag_analytics
+
+> <RAGAnalyticsResponse> get_rag_analytics(tr_dataset, rag_analytics)
+
+Get RAG Analytics
+
+This route allows you to view the RAG analytics for a dataset.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # 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::AnalyticsApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+rag_analytics = TrieveRubyClient::RAGQueries.new({type: 'rag_queries'}) # RAGAnalytics | JSON request payload to filter the graph
+
+begin
+  # Get RAG Analytics
+  result = api_instance.get_rag_analytics(tr_dataset, rag_analytics)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_rag_analytics: #{e}"
+end
+```
+
+#### Using the get_rag_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RAGAnalyticsResponse>, Integer, Hash)> get_rag_analytics_with_http_info(tr_dataset, rag_analytics)
+
+```ruby
+begin
+  # Get RAG Analytics
+  data, status_code, headers = api_instance.get_rag_analytics_with_http_info(tr_dataset, rag_analytics)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RAGAnalyticsResponse>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_rag_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **rag_analytics** | [**RAGAnalytics**](RAGAnalytics.md) | JSON request payload to filter the graph |  |
+
+### Return type
+
+[**RAGAnalyticsResponse**](RAGAnalyticsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_recommendation_analytics
+
+> <RecommendationAnalyticsResponse> get_recommendation_analytics(tr_dataset, recommendation_analytics)
+
+Get Recommendation Analytics
+
+This route allows you to view the recommendation analytics for a dataset.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # 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::AnalyticsApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+recommendation_analytics = TrieveRubyClient::LowConfidenceRecommendations.new({type: 'low_confidence_recommendations'}) # RecommendationAnalytics | JSON request payload to filter the graph
+
+begin
+  # Get Recommendation Analytics
+  result = api_instance.get_recommendation_analytics(tr_dataset, recommendation_analytics)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_recommendation_analytics: #{e}"
+end
+```
+
+#### Using the get_recommendation_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RecommendationAnalyticsResponse>, Integer, Hash)> get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics)
+
+```ruby
+begin
+  # Get Recommendation Analytics
+  data, status_code, headers = api_instance.get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RecommendationAnalyticsResponse>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_recommendation_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **recommendation_analytics** | [**RecommendationAnalytics**](RecommendationAnalytics.md) | JSON request payload to filter the graph |  |
+
+### Return type
+
+[**RecommendationAnalyticsResponse**](RecommendationAnalyticsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_search_analytics
+
+> <SearchAnalyticsResponse> get_search_analytics(tr_dataset, search_analytics)
+
+Get Search Analytics
+
+This route allows you to view the search analytics for a dataset.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # 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::AnalyticsApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+search_analytics = TrieveRubyClient::CountQueries.new({type: 'count_queries'}) # SearchAnalytics | JSON request payload to filter the graph
+
+begin
+  # Get Search Analytics
+  result = api_instance.get_search_analytics(tr_dataset, search_analytics)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_search_analytics: #{e}"
+end
+```
+
+#### Using the get_search_analytics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SearchAnalyticsResponse>, Integer, Hash)> get_search_analytics_with_http_info(tr_dataset, search_analytics)
+
+```ruby
+begin
+  # Get Search Analytics
+  data, status_code, headers = api_instance.get_search_analytics_with_http_info(tr_dataset, search_analytics)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SearchAnalyticsResponse>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling AnalyticsApi->get_search_analytics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **search_analytics** | [**SearchAnalytics**](SearchAnalytics.md) | JSON request payload to filter the graph |  |
+
+### Return type
+
+[**SearchAnalyticsResponse**](SearchAnalyticsResponse.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ApiKeyRespBody.md

@@ -0,0 +1,32 @@
+# TrieveRubyClient::ApiKeyRespBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **dataset_ids** | **Array<String>** |  | [optional] |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **organization_ids** | **Array<String>** |  | [optional] |
+| **role** | **Integer** |  |  |
+| **updated_at** | **Time** |  |  |
+| **user_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ApiKeyRespBody.new(
+  created_at: null,
+  dataset_ids: null,
+  id: null,
+  name: null,
+  organization_ids: null,
+  role: null,
+  updated_at: null,
+  user_id: null
+)
+```
+

data/docs/AuthApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 OpenID Connect callback
 
-OpenID Connect callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
+This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
 
 ### Examples
 
@@ -77,7 +77,7 @@ No authorization required
 
 Get Me
 
-Get Me  Get the user corresponding to your current auth credentials.
+Get the user corresponding to your current auth credentials.
 
 ### Examples
 
@@ -145,7 +145,7 @@ This endpoint does not need any parameter.
 
 Login
 
-Login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
 
 ### Examples
 
@@ -214,7 +214,7 @@ No authorization required
 
 Logout
 
-Logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
+Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
 
 ### Examples
 

data/docs/AutocompleteData.md

@@ -0,0 +1,42 @@
+# TrieveRubyClient::AutocompleteData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_only** | **Boolean** | Set content_only to true to only returning the chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false. | [optional] |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [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 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 sub-sentences. | [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] |
+| **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. |  |
+| **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. We recommend setting this to 1.0 for a gentle reranking of the results, >3.0 for a strong reranking of the results. | [optional] |
+| **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\", or \"fulltext\". \"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. |  |
+| **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 (typically 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_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::AutocompleteData.new(
+  content_only: null,
+  filters: null,
+  highlight_delimiters: null,
+  highlight_results: null,
+  highlight_threshold: null,
+  page_size: null,
+  query: null,
+  recency_bias: null,
+  score_threshold: null,
+  search_type: null,
+  slim_chunks: null,
+  tag_weights: null,
+  use_weights: null
+)
+```
+

data/docs/AutocompleteReqPayload.md

@@ -0,0 +1,54 @@
+# TrieveRubyClient::AutocompleteReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content_only** | **Boolean** | Set content_only to true to only returning the chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false. | [optional] |
+| **extend_results** | **Boolean** | If specified to true, this will extend the search results to include non-exact prefix matches of the same search_type such that a full page_size of results are returned. Default is false. | [optional] |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [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 [\"?\", \",\", \".\", \"!\"]. These are the characters that will be used to split the chunk_html into splits for highlighting. | [optional] |
+| **highlight_max_length** | **Integer** | Set highlight_max_length to control the maximum number of tokens (typically whitespace separated strings, but sometimes also word stems) which can be present within a single highlight. If not specified, this defaults to 8. This is useful to shorten large splits which may have low scores due to length compared to the query. Set to something very large like 100 to highlight entire splits. | [optional] |
+| **highlight_max_num** | **Integer** | Set highlight_max_num to control the maximum number of highlights per chunk. If not specified, this defaults to 3. It may be less than 3 if no snippets score above the highlight_threshold. | [optional] |
+| **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_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. |  |
+| **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. We recommend setting this to 1.0 for a gentle reranking of the results, >3.0 for a strong reranking of the results. | [optional] |
+| **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 (typically 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
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::AutocompleteReqPayload.new(
+  content_only: null,
+  extend_results: null,
+  filters: null,
+  highlight_delimiters: null,
+  highlight_max_length: null,
+  highlight_max_num: null,
+  highlight_results: null,
+  highlight_threshold: null,
+  highlight_window: null,
+  location_bias: null,
+  page_size: null,
+  query: null,
+  recency_bias: null,
+  score_threshold: null,
+  search_type: null,
+  slim_chunks: null,
+  tag_weights: null,
+  use_reranker: null,
+  use_weights: null
+)
+```
+

data/docs/BookmarkGroupResponse.md

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

data/docs/BookmarkGroupResult.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **chunk_uuid** | **String** |  |  |
-| **slim_groups** | [**Array<SlimGroup>**](SlimGroup.md) |  |  |
+| **slim_groups** | [**Array<ChunkGroupAndFileId>**](ChunkGroupAndFileId.md) |  |  |
 
 ## Example
 

data/docs/BoostPhrase.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::BoostPhrase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **boost_factor** | **Float** | Amount to multiplicatevly increase the frequency of the tokens in the phrase by |  |
+| **phrase** | **String** | The phrase to boost in the fulltext document frequency index |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::BoostPhrase.new(
+  boost_factor: null,
+  phrase: null
+)
+```
+

data/docs/ChatMessageProxy.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **content** | **String** |  |  |
-| **role** | **String** |  |  |
+| **role** | [**RoleProxy**](RoleProxy.md) |  |  |
 
 ## Example