trieve_ruby_client 0.10.7 → 0.11.0

data/docs/NoResultQueries.md

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

data/docs/OrganizationApi.md

@@ -18,7 +18,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Create Organization
 
-Create Organization  Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
+Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
 
 ### Examples
 
@@ -89,7 +89,7 @@ end
 
 Delete Organization
 
-Delete Organization  Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
+Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
 
 ### Examples
 
@@ -161,7 +161,7 @@ nil (empty response body)
 
 Get Organization
 
-Get Organization  Fetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
+Fetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -234,7 +234,7 @@ end
 
 Get Organization Usage
 
-Get Organization Usage  Fetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
+Fetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -307,7 +307,7 @@ end
 
 Get Organization Users
 
-Get Organization Users  Fetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
+Fetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -380,7 +380,7 @@ end
 
 Update Organization
 
-Update Organization  Update an organization. Only the owner of the organization can update it.
+Update an organization. Only the owner of the organization can update it.
 
 ### Examples
 

data/docs/QueryCountResponse.md

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

data/docs/QueryDetails.md

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

data/docs/RAGAnalytics.md

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

data/docs/RAGAnalyticsFilter.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::RAGAnalyticsFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_range** | [**DateRange**](DateRange.md) |  | [optional] |
+| **rag_type** | [**RagTypes**](RagTypes.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::RAGAnalyticsFilter.new(
+  date_range: null,
+  rag_type: null
+)
+```
+

data/docs/RAGAnalyticsResponse.md

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

data/docs/RAGQueries.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::RAGQueries
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**RAGAnalyticsFilter**](RAGAnalyticsFilter.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::RAGQueries.new(
+  filter: null,
+  page: null,
+  sort_by: null,
+  sort_order: null,
+  type: null
+)
+```
+

data/docs/RAGUsage.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::RAGUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**RAGAnalyticsFilter**](RAGAnalyticsFilter.md) |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::RAGUsage.new(
+  filter: null,
+  type: null
+)
+```
+

data/docs/RAGUsageResponse.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::RAGUsageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_queries** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::RAGUsageResponse.new(
+  total_queries: null
+)
+```
+

data/docs/RPSGraph.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::RPSGraph
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**SearchAnalyticsFilter**](SearchAnalyticsFilter.md) |  | [optional] |
+| **granularity** | [**Granularity**](Granularity.md) |  | [optional] |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::RPSGraph.new(
+  filter: null,
+  granularity: null,
+  type: null
+)
+```
+

data/docs/RPSGraphResponse.md

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

data/docs/RagQueryEvent.md

@@ -0,0 +1,30 @@
+# TrieveRubyClient::RagQueryEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **rag_type** | **String** |  |  |
+| **results** | [**Array<ChunkMetadataStringTagSet>**](ChunkMetadataStringTagSet.md) |  |  |
+| **search_id** | **String** |  |  |
+| **user_message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::RagQueryEvent.new(
+  created_at: null,
+  dataset_id: null,
+  id: null,
+  rag_type: null,
+  results: null,
+  search_id: null,
+  user_message: null
+)
+```
+

data/docs/RagQueryResponse.md

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

data/docs/RagTypes.md

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

data/docs/RecommendChunksRequest.md

@@ -10,9 +10,9 @@
 | **negative_tracking_ids** | **Array<String>** | The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks. | [optional] |
 | **positive_chunk_ids** | **Array<String>** | The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] |
 | **positive_tracking_ids** | **Array<String>** | The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] |
-| **recommend_type** | **String** | The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`. | [optional] |
+| **recommend_type** | [**RecommendType**](RecommendType.md) |  | [optional] |
 | **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] |
-| **strategy** | **String** | Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives. | [optional] |
+| **strategy** | [**RecommendationStrategy**](RecommendationStrategy.md) |  | [optional] |
 
 ## Example
 

data/docs/RecommendChunksResponseBody.md

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

data/docs/RecommendGroupChunksRequest.md

@@ -11,9 +11,9 @@
 | **negative_group_tracking_ids** | **Array<String>** | The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups. | [optional] |
 | **positive_group_ids** | **Array<String>** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
 | **positive_group_tracking_ids** | **Array<String>** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
-| **recommend_type** | **String** | The type of recommendation to make. This lets you choose whether to recommend based off of `semantic` or `fulltext` similarity. The default is `semantic`. | [optional] |
+| **recommend_type** | [**RecommendType**](RecommendType.md) |  | [optional] |
 | **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] |
-| **strategy** | **String** | Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives. | [optional] |
+| **strategy** | [**RecommendationStrategy**](RecommendationStrategy.md) |  | [optional] |
 
 ## Example
 

data/docs/RecommendGroupsResponse.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::RecommendGroupsResponse
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::RecommendGroupsResponse.openapi_one_of
+# =>
+# [
+#   :'GroupScoreChunk',
+#   :'RecommendGroupsResponseBody'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::RecommendGroupsResponse.build(data)
+# => #<GroupScoreChunk:0x00007fdd4aab02a0>
+
+TrieveRubyClient::RecommendGroupsResponse.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`
+- `RecommendGroupsResponseBody`
+- `nil` (if no type matches)
+

data/docs/RecommendGroupsResponseBody.md

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

data/docs/RecommendResponseTypes.md

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

data/docs/RecommendType.md

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

data/docs/RecommendationAnalytics.md

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