trieve_ruby_client 0.8.0 → 0.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b011a732a1c100768658282b5cc12fde441a13858d278e0f04cd58124a1091c5
-  data.tar.gz: 72b1840e88e682f1b866deab79654b1478c43fd3107f46d89c822f47bf1483de
+  metadata.gz: 1a168187dd7ee17f3200711aa37293b261c6c2b1efcdabbcaf20824b447d13af
+  data.tar.gz: c034af1fdb2902e0190b7493984f5a5b2517e76a12d83581fedb50f129926b14
 SHA512:
-  metadata.gz: 2204107a561fa98633b5f69b7aa0de92a1e4e6ae1fd422cc22527af6a9e847858c1bf05119be00d98c0846a0567d9ad1cbc471ef7e27418edab3a000a984f4ea
-  data.tar.gz: 27bf39cd2e4b253af367b39f9be0050a8630c571d70c323ff0f27a2effc117fff159577a36a82a72e6ef6e3b56dd708fac89290c9d75d22425f11e5a8409938e
+  metadata.gz: a90adfe8bf23396bb6a5bee60fae21870edf82a072303090601787ab084e33459c4da8e32487593249077734797bce8b8e933ecb5ff83f07401c7c4a5d64cfeb
+  data.tar.gz: 2f8dd54c97384240971243258e27c0ae950b5cd8d178e850dd12b380c0b60a9c953c94a583447770f23abadcfd154c5daee2659b304fe7a36a78142f8472ff88

data/README.md

@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.8.0
-- Package version: 0.8.0
+- API version: 0.10.7
+- Package version: 0.10.7
 - Generator version: 7.4.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://trieve.ai](https://trieve.ai)
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./trieve_ruby_client-0.8.0.gem
+gem install ./trieve_ruby_client-0.10.7.gem
 ```
 
-(for development, run `gem install --dev ./trieve_ruby_client-0.8.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./trieve_ruby_client-0.10.7.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'trieve_ruby_client', '~> 0.8.0'
+    gem 'trieve_ruby_client', '~> 0.10.7'
 
 ### Install from Git
 
@@ -80,8 +80,8 @@ Class | Method | HTTP request | Description
 *TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
 *TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
 *TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
+*TrieveRubyClient::ChunkApi* | [**autocomplete**](docs/ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete
 *TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
-*TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
 *TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
 *TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id
 *TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
 *TrieveRubyClient::ChunkApi* | [**get_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids
 *TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds
 *TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
+*TrieveRubyClient::ChunkApi* | [**get_suggested_queries**](docs/ChunkApi.md#get_suggested_queries) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
 *TrieveRubyClient::ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search
 *TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
 *TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
@@ -110,11 +111,14 @@ Class | Method | HTTP request | Description
 *TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group
 *TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
 *TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
+*TrieveRubyClient::DatasetApi* | [**clear_dataset**](docs/DatasetApi.md#clear_dataset) | **PUT** /api/dataset/clear/{dataset_id} | Clear Dataset
 *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
 *TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
+*TrieveRubyClient::DatasetApi* | [**delete_dataset_by_tracking_id**](docs/DatasetApi.md#delete_dataset_by_tracking_id) | **DELETE** /api/dataset/tracking_id/{tracking_id} | Delete Dataset by Tracking ID
 *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
 *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
 *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
+*TrieveRubyClient::DatasetApi* | [**get_usage_by_dataset_id**](docs/DatasetApi.md#get_usage_by_dataset_id) | **GET** /api/dataset/usage/{dataset_id} | Get Usage By Dataset ID
 *TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset
 *TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset
 *TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File
@@ -123,13 +127,13 @@ Class | Method | HTTP request | Description
 *TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | Upload File
 *TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | Health Check
 *TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation
-*TrieveRubyClient::MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message | Create a message
-*TrieveRubyClient::MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | Edit a message
+*TrieveRubyClient::MessageApi* | [**create_message**](docs/MessageApi.md#create_message) | **POST** /api/message | Create message
+*TrieveRubyClient::MessageApi* | [**edit_message**](docs/MessageApi.md#edit_message) | **PUT** /api/message | Edit message
 *TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic
-*TrieveRubyClient::MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | Regenerate message
+*TrieveRubyClient::MessageApi* | [**regenerate_message**](docs/MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message
 *TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization
-*TrieveRubyClient::OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete Organization
-*TrieveRubyClient::OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | Get Organization
+*TrieveRubyClient::OrganizationApi* | [**delete_organization**](docs/OrganizationApi.md#delete_organization) | **DELETE** /api/organization/{organization_id} | Delete Organization
+*TrieveRubyClient::OrganizationApi* | [**get_organization**](docs/OrganizationApi.md#get_organization) | **GET** /api/organization/{organization_id} | Get Organization
 *TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage
 *TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users
 *TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization
@@ -149,32 +153,39 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)
- - [TrieveRubyClient::ApiKeyDTO](docs/ApiKeyDTO.md)
+ - [TrieveRubyClient::ApiKeyRespBody](docs/ApiKeyRespBody.md)
  - [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)
+ - [TrieveRubyClient::AutocompleteReqPayload](docs/AutocompleteReqPayload.md)
  - [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)
  - [TrieveRubyClient::BookmarkData](docs/BookmarkData.md)
  - [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)
+ - [TrieveRubyClient::BoostPhrase](docs/BoostPhrase.md)
  - [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)
- - [TrieveRubyClient::ChunkData](docs/ChunkData.md)
  - [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)
  - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
  - [TrieveRubyClient::ChunkGroupAndFile](docs/ChunkGroupAndFile.md)
  - [TrieveRubyClient::ChunkMetadata](docs/ChunkMetadata.md)
+ - [TrieveRubyClient::ChunkMetadataStringTagSet](docs/ChunkMetadataStringTagSet.md)
+ - [TrieveRubyClient::ChunkMetadataTypes](docs/ChunkMetadataTypes.md)
  - [TrieveRubyClient::ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)
+ - [TrieveRubyClient::ChunkReqPayload](docs/ChunkReqPayload.md)
  - [TrieveRubyClient::ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)
- - [TrieveRubyClient::CreateChunkData](docs/CreateChunkData.md)
- - [TrieveRubyClient::CreateChunkGroupData](docs/CreateChunkGroupData.md)
+ - [TrieveRubyClient::ConditionType](docs/ConditionType.md)
+ - [TrieveRubyClient::ContentChunkMetadata](docs/ContentChunkMetadata.md)
+ - [TrieveRubyClient::CreateChunkGroupReqPayload](docs/CreateChunkGroupReqPayload.md)
+ - [TrieveRubyClient::CreateChunkReqPayloadEnum](docs/CreateChunkReqPayloadEnum.md)
  - [TrieveRubyClient::CreateDatasetRequest](docs/CreateDatasetRequest.md)
- - [TrieveRubyClient::CreateMessageData](docs/CreateMessageData.md)
+ - [TrieveRubyClient::CreateMessageReqPayload](docs/CreateMessageReqPayload.md)
  - [TrieveRubyClient::CreateOrganizationData](docs/CreateOrganizationData.md)
- - [TrieveRubyClient::CreateTopicData](docs/CreateTopicData.md)
+ - [TrieveRubyClient::CreateTopicReqPayload](docs/CreateTopicReqPayload.md)
  - [TrieveRubyClient::Dataset](docs/Dataset.md)
  - [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
  - [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
  - [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
+ - [TrieveRubyClient::DateRange](docs/DateRange.md)
  - [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
  - [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
- - [TrieveRubyClient::EditMessageData](docs/EditMessageData.md)
+ - [TrieveRubyClient::EditMessageReqPayload](docs/EditMessageReqPayload.md)
  - [TrieveRubyClient::ErrorResponseBody](docs/ErrorResponseBody.md)
  - [TrieveRubyClient::Event](docs/Event.md)
  - [TrieveRubyClient::EventReturn](docs/EventReturn.md)
@@ -185,12 +196,13 @@ Class | Method | HTTP request | Description
  - [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)
  - [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)
  - [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)
+ - [TrieveRubyClient::GetDatasetsPagination](docs/GetDatasetsPagination.md)
  - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
  - [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
  - [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)
- - [TrieveRubyClient::GroupScoreSlimChunks](docs/GroupScoreSlimChunks.md)
+ - [TrieveRubyClient::HasIDCondition](docs/HasIDCondition.md)
  - [TrieveRubyClient::InvitationData](docs/InvitationData.md)
  - [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)
  - [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)
@@ -203,19 +215,16 @@ Class | Method | HTTP request | Description
  - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
  - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
  - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
- - [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
+ - [TrieveRubyClient::RegenerateMessageReqPayload](docs/RegenerateMessageReqPayload.md)
+ - [TrieveRubyClient::RemoveChunkFromGroupReqPayload](docs/RemoveChunkFromGroupReqPayload.md)
  - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
  - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
- - [TrieveRubyClient::ScoreSlimChunks](docs/ScoreSlimChunks.md)
- - [TrieveRubyClient::SearchChunkData](docs/SearchChunkData.md)
  - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
+ - [TrieveRubyClient::SearchChunksReqPayload](docs/SearchChunksReqPayload.md)
  - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
  - [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)
- - [TrieveRubyClient::SearchOverGroupsSlimResults](docs/SearchOverGroupsSlimResults.md)
- - [TrieveRubyClient::SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
  - [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)
- - [TrieveRubyClient::SearchWithinGroupSlimResults](docs/SearchWithinGroupSlimResults.md)
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
  - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
@@ -224,18 +233,18 @@ Class | Method | HTTP request | Description
  - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
  - [TrieveRubyClient::StripePlan](docs/StripePlan.md)
- - [TrieveRubyClient::SuggestedQueriesRequest](docs/SuggestedQueriesRequest.md)
+ - [TrieveRubyClient::SuggestedQueriesReqPayload](docs/SuggestedQueriesReqPayload.md)
  - [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)
  - [TrieveRubyClient::Topic](docs/Topic.md)
  - [TrieveRubyClient::UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)
- - [TrieveRubyClient::UpdateChunkData](docs/UpdateChunkData.md)
  - [TrieveRubyClient::UpdateChunkGroupData](docs/UpdateChunkGroupData.md)
+ - [TrieveRubyClient::UpdateChunkReqPayload](docs/UpdateChunkReqPayload.md)
  - [TrieveRubyClient::UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
- - [TrieveRubyClient::UpdateGroupByTrackingIDData](docs/UpdateGroupByTrackingIDData.md)
+ - [TrieveRubyClient::UpdateGroupByTrackingIDReqPayload](docs/UpdateGroupByTrackingIDReqPayload.md)
  - [TrieveRubyClient::UpdateOrganizationData](docs/UpdateOrganizationData.md)
- - [TrieveRubyClient::UpdateTopicData](docs/UpdateTopicData.md)
+ - [TrieveRubyClient::UpdateTopicReqPayload](docs/UpdateTopicReqPayload.md)
  - [TrieveRubyClient::UpdateUserOrgRoleData](docs/UpdateUserOrgRoleData.md)
- - [TrieveRubyClient::UploadFileData](docs/UploadFileData.md)
+ - [TrieveRubyClient::UploadFileReqPayload](docs/UploadFileReqPayload.md)
  - [TrieveRubyClient::UploadFileResult](docs/UploadFileResult.md)
  - [TrieveRubyClient::UserOrganization](docs/UserOrganization.md)
 

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/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,50 @@
+# 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] |
+| **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_size of the nearest cosine distant vectors. \"fulltext\" will pull in one page_size 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::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,
+  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/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
+)
+```
+