Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/devflowinc/trieve-ruby-client

Ruby Client for Trieve REST API
https://github.com/devflowinc/trieve-ruby-client

Last synced: 6 months ago
JSON representation

Ruby Client for Trieve REST API

Awesome Lists containing this project

README 

          
# trieve_ruby_client



TrieveRubyClient - the Ruby gem for the Trieve API



Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.



This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:



- API version: 0.11.0

- Package version: 0.11.0

- Generator version: 7.4.0

- Build package: org.openapitools.codegen.languages.RubyClientCodegen

For more information, please visit [https://trieve.ai](https://trieve.ai)



## Installation



### Build a gem



To build the Ruby code into a gem:



```shell

gem build trieve_ruby_client.gemspec

```



Then either install the gem locally:



```shell

gem install ./trieve_ruby_client-0.11.0.gem

```



(for development, run `gem install --dev ./trieve_ruby_client-0.11.0.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.11.0'



### Install from Git



If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:



    gem 'trieve_ruby_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'



### Include the Ruby code directly



Include the Ruby code directly using `-I` as follows:



```shell

ruby -Ilib script.rb

```



## Getting Started



Please follow the [installation](#installation) procedure and then run the following code:



```ruby

# Load the gem

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 "Exception when calling AnalyticsApi->get_cluster_analytics: #{e}"

end



```



## Documentation for API Endpoints



All URIs are relative to *https://api.trieve.ai*



Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*TrieveRubyClient::AnalyticsApi* | [**get_cluster_analytics**](docs/AnalyticsApi.md#get_cluster_analytics) | **POST** /api/analytics/search/cluster | Get Cluster Analytics

*TrieveRubyClient::AnalyticsApi* | [**get_rag_analytics**](docs/AnalyticsApi.md#get_rag_analytics) | **POST** /api/analytics/rag | Get RAG Analytics

*TrieveRubyClient::AnalyticsApi* | [**get_recommendation_analytics**](docs/AnalyticsApi.md#get_recommendation_analytics) | **POST** /api/analytics/recommendation | Get Recommendation Analytics

*TrieveRubyClient::AnalyticsApi* | [**get_search_analytics**](docs/AnalyticsApi.md#get_search_analytics) | **POST** /api/analytics/search | Get Search Analytics

*TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback

*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* | [**count_chunks**](docs/ChunkApi.md#count_chunks) | **POST** /api/chunk/count | Count chunks above threshold

*TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks

*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

*TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id

*TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id

*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 Tracking Ids

*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

*TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group

*TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group_by_tracking_id**](docs/ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID

*TrieveRubyClient::ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group

*TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group

*TrieveRubyClient::ChunkGroupApi* | [**delete_group_by_tracking_id**](docs/ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID

*TrieveRubyClient::ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{group_id} | Get Group

*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group

*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID

*TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID

*TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks

*TrieveRubyClient::ChunkGroupApi* | [**get_groups_for_dataset**](docs/ChunkGroupApi.md#get_groups_for_dataset) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset

*TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups

*TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group

*TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups

*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_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

*TrieveRubyClient::FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | Get Files for Dataset

*TrieveRubyClient::FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | Get File

*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**](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**](docs/MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message

*TrieveRubyClient::MetricsApi* | [**get_metrics**](docs/MetricsApi.md#get_metrics) | **POST** /metrics | Get Prometheus Metrics

*TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create 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

*TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription

*TrieveRubyClient::StripeApi* | [**create_setup_checkout_session**](docs/StripeApi.md#create_setup_checkout_session) | **POST** /api/stripe/checkout/setup/{organization_id} | Create checkout session setup

*TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout

*TrieveRubyClient::StripeApi* | [**get_all_invoices**](docs/StripeApi.md#get_all_invoices) | **GET** /api/stripe/invoices/{organization_id} | Get All Invoices

*TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans

*TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan

*TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic

*TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic

*TrieveRubyClient::TopicApi* | [**get_all_topics_for_owner_id**](docs/TopicApi.md#get_all_topics_for_owner_id) | **GET** /api/topic/owner/{owner_id} | Get All Topics for Owner ID

*TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic

*TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/api_key/{api_key_id} | Delete User Api Key

*TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/api_key | Set User Api Key

*TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User



## Documentation for Models



 - [TrieveRubyClient::APIVersion](docs/APIVersion.md)

 - [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)

 - [TrieveRubyClient::ApiKeyRespBody](docs/ApiKeyRespBody.md)

 - [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)

 - [TrieveRubyClient::AutocompleteReqPayload](docs/AutocompleteReqPayload.md)

 - [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)

 - [TrieveRubyClient::BookmarkGroupResponse](docs/BookmarkGroupResponse.md)

 - [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)

 - [TrieveRubyClient::BoostPhrase](docs/BoostPhrase.md)

 - [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)

 - [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)

 - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)

 - [TrieveRubyClient::ChunkGroupAndFileId](docs/ChunkGroupAndFileId.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::ChunkReturnTypes](docs/ChunkReturnTypes.md)

 - [TrieveRubyClient::ClusterAnalytics](docs/ClusterAnalytics.md)

 - [TrieveRubyClient::ClusterAnalyticsFilter](docs/ClusterAnalyticsFilter.md)

 - [TrieveRubyClient::ClusterAnalyticsResponse](docs/ClusterAnalyticsResponse.md)

 - [TrieveRubyClient::ClusterQueries](docs/ClusterQueries.md)

 - [TrieveRubyClient::ClusterTopics](docs/ClusterTopics.md)

 - [TrieveRubyClient::ConditionType](docs/ConditionType.md)

 - [TrieveRubyClient::ContentChunkMetadata](docs/ContentChunkMetadata.md)

 - [TrieveRubyClient::CountChunkQueryResponseBody](docs/CountChunkQueryResponseBody.md)

 - [TrieveRubyClient::CountChunksReqPayload](docs/CountChunksReqPayload.md)

 - [TrieveRubyClient::CountQueries](docs/CountQueries.md)

 - [TrieveRubyClient::CreateChunkGroupReqPayload](docs/CreateChunkGroupReqPayload.md)

 - [TrieveRubyClient::CreateChunkReqPayloadEnum](docs/CreateChunkReqPayloadEnum.md)

 - [TrieveRubyClient::CreateDatasetRequest](docs/CreateDatasetRequest.md)

 - [TrieveRubyClient::CreateMessageReqPayload](docs/CreateMessageReqPayload.md)

 - [TrieveRubyClient::CreateOrganizationData](docs/CreateOrganizationData.md)

 - [TrieveRubyClient::CreateSetupCheckoutSessionResPayload](docs/CreateSetupCheckoutSessionResPayload.md)

 - [TrieveRubyClient::CreateTopicReqPayload](docs/CreateTopicReqPayload.md)

 - [TrieveRubyClient::Dataset](docs/Dataset.md)

 - [TrieveRubyClient::DatasetAnalytics](docs/DatasetAnalytics.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::DeprecatedSearchOverGroupsResponseBody](docs/DeprecatedSearchOverGroupsResponseBody.md)

 - [TrieveRubyClient::DistancePhrase](docs/DistancePhrase.md)

 - [TrieveRubyClient::EditMessageReqPayload](docs/EditMessageReqPayload.md)

 - [TrieveRubyClient::ErrorResponseBody](docs/ErrorResponseBody.md)

 - [TrieveRubyClient::Event](docs/Event.md)

 - [TrieveRubyClient::EventReturn](docs/EventReturn.md)

 - [TrieveRubyClient::EventTypeRequest](docs/EventTypeRequest.md)

 - [TrieveRubyClient::FieldCondition](docs/FieldCondition.md)

 - [TrieveRubyClient::File](docs/File.md)

 - [TrieveRubyClient::FileDTO](docs/FileDTO.md)

 - [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)

 - [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)

 - [TrieveRubyClient::GeoInfoWithBias](docs/GeoInfoWithBias.md)

 - [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)

 - [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)

 - [TrieveRubyClient::GetChunksForGroupsResponse](docs/GetChunksForGroupsResponse.md)

 - [TrieveRubyClient::GetDatasetsPagination](docs/GetDatasetsPagination.md)

 - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)

 - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)

 - [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)

 - [TrieveRubyClient::Granularity](docs/Granularity.md)

 - [TrieveRubyClient::GroupData](docs/GroupData.md)

 - [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)

 - [TrieveRubyClient::GroupsBookmarkQueryResult](docs/GroupsBookmarkQueryResult.md)

 - [TrieveRubyClient::HasIDCondition](docs/HasIDCondition.md)

 - [TrieveRubyClient::HeadQueries](docs/HeadQueries.md)

 - [TrieveRubyClient::HeadQueries1](docs/HeadQueries1.md)

 - [TrieveRubyClient::HeadQueryResponse](docs/HeadQueryResponse.md)

 - [TrieveRubyClient::InvitationData](docs/InvitationData.md)

 - [TrieveRubyClient::LatencyGraph](docs/LatencyGraph.md)

 - [TrieveRubyClient::LatencyGraphResponse](docs/LatencyGraphResponse.md)

 - [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)

 - [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)

 - [TrieveRubyClient::LocationRadius](docs/LocationRadius.md)

 - [TrieveRubyClient::LowConfidenceQueries](docs/LowConfidenceQueries.md)

 - [TrieveRubyClient::LowConfidenceRecommendations](docs/LowConfidenceRecommendations.md)

 - [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)

 - [TrieveRubyClient::Message](docs/Message.md)

 - [TrieveRubyClient::NewChunkMetadataTypes](docs/NewChunkMetadataTypes.md)

 - [TrieveRubyClient::NoResultQueries](docs/NoResultQueries.md)

 - [TrieveRubyClient::Organization](docs/Organization.md)

 - [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)

 - [TrieveRubyClient::QueryCountResponse](docs/QueryCountResponse.md)

 - [TrieveRubyClient::QueryDetails](docs/QueryDetails.md)

 - [TrieveRubyClient::RAGAnalytics](docs/RAGAnalytics.md)

 - [TrieveRubyClient::RAGAnalyticsFilter](docs/RAGAnalyticsFilter.md)

 - [TrieveRubyClient::RAGAnalyticsResponse](docs/RAGAnalyticsResponse.md)

 - [TrieveRubyClient::RAGQueries](docs/RAGQueries.md)

 - [TrieveRubyClient::RAGUsage](docs/RAGUsage.md)

 - [TrieveRubyClient::RAGUsageResponse](docs/RAGUsageResponse.md)

 - [TrieveRubyClient::RPSGraph](docs/RPSGraph.md)

 - [TrieveRubyClient::RPSGraphResponse](docs/RPSGraphResponse.md)

 - [TrieveRubyClient::RagQueryEvent](docs/RagQueryEvent.md)

 - [TrieveRubyClient::RagQueryResponse](docs/RagQueryResponse.md)

 - [TrieveRubyClient::RagTypes](docs/RagTypes.md)

 - [TrieveRubyClient::Range](docs/Range.md)

 - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)

 - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)

 - [TrieveRubyClient::RecommendChunksResponseBody](docs/RecommendChunksResponseBody.md)

 - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)

 - [TrieveRubyClient::RecommendGroupsResponse](docs/RecommendGroupsResponse.md)

 - [TrieveRubyClient::RecommendGroupsResponseBody](docs/RecommendGroupsResponseBody.md)

 - [TrieveRubyClient::RecommendResponseTypes](docs/RecommendResponseTypes.md)

 - [TrieveRubyClient::RecommendType](docs/RecommendType.md)

 - [TrieveRubyClient::RecommendationAnalytics](docs/RecommendationAnalytics.md)

 - [TrieveRubyClient::RecommendationAnalyticsFilter](docs/RecommendationAnalyticsFilter.md)

 - [TrieveRubyClient::RecommendationAnalyticsResponse](docs/RecommendationAnalyticsResponse.md)

 - [TrieveRubyClient::RecommendationEvent](docs/RecommendationEvent.md)

 - [TrieveRubyClient::RecommendationQueries](docs/RecommendationQueries.md)

 - [TrieveRubyClient::RecommendationStrategy](docs/RecommendationStrategy.md)

 - [TrieveRubyClient::RecommendationType](docs/RecommendationType.md)

 - [TrieveRubyClient::RecommendationsEventResponse](docs/RecommendationsEventResponse.md)

 - [TrieveRubyClient::RegenerateMessageReqPayload](docs/RegenerateMessageReqPayload.md)

 - [TrieveRubyClient::RemoveChunkFromGroupReqPayload](docs/RemoveChunkFromGroupReqPayload.md)

 - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)

 - [TrieveRubyClient::RoleProxy](docs/RoleProxy.md)

 - [TrieveRubyClient::ScoreChunk](docs/ScoreChunk.md)

 - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)

 - [TrieveRubyClient::SearchAnalytics](docs/SearchAnalytics.md)

 - [TrieveRubyClient::SearchAnalyticsFilter](docs/SearchAnalyticsFilter.md)

 - [TrieveRubyClient::SearchAnalyticsResponse](docs/SearchAnalyticsResponse.md)

 - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)

 - [TrieveRubyClient::SearchChunksReqPayload](docs/SearchChunksReqPayload.md)

 - [TrieveRubyClient::SearchClusterResponse](docs/SearchClusterResponse.md)

 - [TrieveRubyClient::SearchClusterTopics](docs/SearchClusterTopics.md)

 - [TrieveRubyClient::SearchGroupResponseTypes](docs/SearchGroupResponseTypes.md)

 - [TrieveRubyClient::SearchLatencyGraph](docs/SearchLatencyGraph.md)

 - [TrieveRubyClient::SearchMethod](docs/SearchMethod.md)

 - [TrieveRubyClient::SearchMetrics](docs/SearchMetrics.md)

 - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)

 - [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)

 - [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)

 - [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)

 - [TrieveRubyClient::SearchQueries](docs/SearchQueries.md)

 - [TrieveRubyClient::SearchQueryEvent](docs/SearchQueryEvent.md)

 - [TrieveRubyClient::SearchQueryResponse](docs/SearchQueryResponse.md)

 - [TrieveRubyClient::SearchRPSGraph](docs/SearchRPSGraph.md)

 - [TrieveRubyClient::SearchResponseBody](docs/SearchResponseBody.md)

 - [TrieveRubyClient::SearchResponseTypes](docs/SearchResponseTypes.md)

 - [TrieveRubyClient::SearchResultType](docs/SearchResultType.md)

 - [TrieveRubyClient::SearchType](docs/SearchType.md)

 - [TrieveRubyClient::SearchTypeCount](docs/SearchTypeCount.md)

 - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)

 - [TrieveRubyClient::SearchWithinGroupResponseBody](docs/SearchWithinGroupResponseBody.md)

 - [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)

 - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)

 - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)

 - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)

 - [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)

 - [TrieveRubyClient::SlimChunkMetadataWithArrayTagSet](docs/SlimChunkMetadataWithArrayTagSet.md)

 - [TrieveRubyClient::SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)

 - [TrieveRubyClient::SlimUser](docs/SlimUser.md)

 - [TrieveRubyClient::SortBy](docs/SortBy.md)

 - [TrieveRubyClient::SortOrder](docs/SortOrder.md)

 - [TrieveRubyClient::StripeInvoice](docs/StripeInvoice.md)

 - [TrieveRubyClient::StripePlan](docs/StripePlan.md)

 - [TrieveRubyClient::SuggestedQueriesReqPayload](docs/SuggestedQueriesReqPayload.md)

 - [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)

 - [TrieveRubyClient::Topic](docs/Topic.md)

 - [TrieveRubyClient::UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)

 - [TrieveRubyClient::UpdateChunkGroupData](docs/UpdateChunkGroupData.md)

 - [TrieveRubyClient::UpdateChunkReqPayload](docs/UpdateChunkReqPayload.md)

 - [TrieveRubyClient::UpdateDatasetRequest](docs/UpdateDatasetRequest.md)

 - [TrieveRubyClient::UpdateGroupByTrackingIDReqPayload](docs/UpdateGroupByTrackingIDReqPayload.md)

 - [TrieveRubyClient::UpdateOrganizationData](docs/UpdateOrganizationData.md)

 - [TrieveRubyClient::UpdateTopicReqPayload](docs/UpdateTopicReqPayload.md)

 - [TrieveRubyClient::UpdateUserOrgRoleData](docs/UpdateUserOrgRoleData.md)

 - [TrieveRubyClient::UploadFileReqPayload](docs/UploadFileReqPayload.md)

 - [TrieveRubyClient::UploadFileResult](docs/UploadFileResult.md)

 - [TrieveRubyClient::UserOrganization](docs/UserOrganization.md)



## Documentation for Authorization



Authentication schemes defined for the API:

### ApiKey



- **Type**: API key

- **API key parameter name**: Authorization

- **Location**: HTTP header



### X-API-KEY



- **Type**: API key

- **API key parameter name**: X-API-KEY

- **Location**: HTTP header