{"id":28965899,"url":"https://github.com/devflowinc/trieve-ruby-client","last_synced_at":"2025-06-24T07:10:33.662Z","repository":{"id":228417800,"uuid":"773889431","full_name":"devflowinc/trieve-ruby-client","owner":"devflowinc","description":"Ruby Client for Trieve REST API","archived":false,"fork":false,"pushed_at":"2024-07-15T20:08:49.000Z","size":1162,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-22T05:17:06.840Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devflowinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-18T15:21:19.000Z","updated_at":"2024-07-15T20:08:56.000Z","dependencies_parsed_at":"2024-03-18T22:41:18.724Z","dependency_job_id":"4c3f9880-7e66-42d1-a74e-dbd43bfc9bbf","html_url":"https://github.com/devflowinc/trieve-ruby-client","commit_stats":null,"previous_names":["devflowinc/ruby-sdk","devflowinc/trieve-ruby-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devflowinc/trieve-ruby-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-ruby-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-ruby-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-ruby-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-ruby-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devflowinc","download_url":"https://codeload.github.com/devflowinc/trieve-ruby-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-ruby-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261624969,"owners_count":23186121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-24T07:10:32.997Z","updated_at":"2025-06-24T07:10:33.649Z","avatar_url":"https://github.com/devflowinc.png","language":"Ruby","readme":"# trieve_ruby_client\n\nTrieveRubyClient - the Ruby gem for the Trieve API\n\nTrieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.11.0\n- Package version: 0.11.0\n- Generator version: 7.4.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\nFor more information, please visit [https://trieve.ai](https://trieve.ai)\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build trieve_ruby_client.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./trieve_ruby_client-0.11.0.gem\n```\n\n(for development, run `gem install --dev ./trieve_ruby_client-0.11.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'trieve_ruby_client', '~\u003e 0.11.0'\n\n### Install from Git\n\nIf 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:\n\n    gem 'trieve_ruby_client', :git =\u003e 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n\n```ruby\n# Load the gem\nrequire 'trieve_ruby_client'\n\n# Setup authorization\nTrieveRubyClient.configure do |config|\n  # Configure API key authorization: ApiKey\n  config.api_key['ApiKey'] = 'YOUR API KEY'\n  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)\n  # config.api_key_prefix['ApiKey'] = 'Bearer'\nend\n\napi_instance = TrieveRubyClient::AnalyticsApi.new\ntr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request\ncluster_analytics = TrieveRubyClient::ClusterQueries.new({cluster_id: 'cluster_id_example', type: 'cluster_queries'}) # ClusterAnalytics | JSON request payload to filter the graph\n\nbegin\n  #Get Cluster Analytics\n  result = api_instance.get_cluster_analytics(tr_dataset, cluster_analytics)\n  p result\nrescue TrieveRubyClient::ApiError =\u003e e\n  puts \"Exception when calling AnalyticsApi-\u003eget_cluster_analytics: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.trieve.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*TrieveRubyClient::AnalyticsApi* | [**get_cluster_analytics**](docs/AnalyticsApi.md#get_cluster_analytics) | **POST** /api/analytics/search/cluster | Get Cluster Analytics\n*TrieveRubyClient::AnalyticsApi* | [**get_rag_analytics**](docs/AnalyticsApi.md#get_rag_analytics) | **POST** /api/analytics/rag | Get RAG Analytics\n*TrieveRubyClient::AnalyticsApi* | [**get_recommendation_analytics**](docs/AnalyticsApi.md#get_recommendation_analytics) | **POST** /api/analytics/recommendation | Get Recommendation Analytics\n*TrieveRubyClient::AnalyticsApi* | [**get_search_analytics**](docs/AnalyticsApi.md#get_search_analytics) | **POST** /api/analytics/search | Get Search Analytics\n*TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback\n*TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me\n*TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login\n*TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout\n*TrieveRubyClient::ChunkApi* | [**autocomplete**](docs/ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete\n*TrieveRubyClient::ChunkApi* | [**count_chunks**](docs/ChunkApi.md#count_chunks) | **POST** /api/chunk/count | Count chunks above threshold\n*TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks\n*TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk\n*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\n*TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks\n*TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id\n*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\n*TrieveRubyClient::ChunkApi* | [**get_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids\n*TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By Tracking Ids\n*TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks\n*TrieveRubyClient::ChunkApi* | [**get_suggested_queries**](docs/ChunkApi.md#get_suggested_queries) | **POST** /api/chunk/gen_suggestions | Generate suggested queries\n*TrieveRubyClient::ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search\n*TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk\n*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\n*TrieveRubyClient::ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group\n*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\n*TrieveRubyClient::ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group\n*TrieveRubyClient::ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group\n*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\n*TrieveRubyClient::ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{group_id} | Get Group\n*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group\n*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\n*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\n*TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks\n*TrieveRubyClient::ChunkGroupApi* | [**get_groups_for_dataset**](docs/ChunkGroupApi.md#get_groups_for_dataset) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset\n*TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups\n*TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group\n*TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups\n*TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group\n*TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group\n*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\n*TrieveRubyClient::DatasetApi* | [**clear_dataset**](docs/DatasetApi.md#clear_dataset) | **PUT** /api/dataset/clear/{dataset_id} | Clear Dataset\n*TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset\n*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset\n*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\n*TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset\n*TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization\n*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\n*TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset\n*TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset\n*TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File\n*TrieveRubyClient::FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | Get Files for Dataset\n*TrieveRubyClient::FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | Get File\n*TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | Upload File\n*TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | Health Check\n*TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation\n*TrieveRubyClient::MessageApi* | [**create_message**](docs/MessageApi.md#create_message) | **POST** /api/message | Create message\n*TrieveRubyClient::MessageApi* | [**edit_message**](docs/MessageApi.md#edit_message) | **PUT** /api/message | Edit message\n*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\n*TrieveRubyClient::MessageApi* | [**regenerate_message**](docs/MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message\n*TrieveRubyClient::MetricsApi* | [**get_metrics**](docs/MetricsApi.md#get_metrics) | **POST** /metrics | Get Prometheus Metrics\n*TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization\n*TrieveRubyClient::OrganizationApi* | [**delete_organization**](docs/OrganizationApi.md#delete_organization) | **DELETE** /api/organization/{organization_id} | Delete Organization\n*TrieveRubyClient::OrganizationApi* | [**get_organization**](docs/OrganizationApi.md#get_organization) | **GET** /api/organization/{organization_id} | Get Organization\n*TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage\n*TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users\n*TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization\n*TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription\n*TrieveRubyClient::StripeApi* | [**create_setup_checkout_session**](docs/StripeApi.md#create_setup_checkout_session) | **POST** /api/stripe/checkout/setup/{organization_id} | Create checkout session setup\n*TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout\n*TrieveRubyClient::StripeApi* | [**get_all_invoices**](docs/StripeApi.md#get_all_invoices) | **GET** /api/stripe/invoices/{organization_id} | Get All Invoices\n*TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans\n*TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan\n*TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic\n*TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic\n*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\n*TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic\n*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\n*TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/api_key | Set User Api Key\n*TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User\n\n\n## Documentation for Models\n\n - [TrieveRubyClient::APIVersion](docs/APIVersion.md)\n - [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)\n - [TrieveRubyClient::ApiKeyRespBody](docs/ApiKeyRespBody.md)\n - [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)\n - [TrieveRubyClient::AutocompleteReqPayload](docs/AutocompleteReqPayload.md)\n - [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)\n - [TrieveRubyClient::BookmarkGroupResponse](docs/BookmarkGroupResponse.md)\n - [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)\n - [TrieveRubyClient::BoostPhrase](docs/BoostPhrase.md)\n - [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)\n - [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)\n - [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)\n - [TrieveRubyClient::ChunkGroupAndFileId](docs/ChunkGroupAndFileId.md)\n - [TrieveRubyClient::ChunkMetadata](docs/ChunkMetadata.md)\n - [TrieveRubyClient::ChunkMetadataStringTagSet](docs/ChunkMetadataStringTagSet.md)\n - [TrieveRubyClient::ChunkMetadataTypes](docs/ChunkMetadataTypes.md)\n - [TrieveRubyClient::ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)\n - [TrieveRubyClient::ChunkReqPayload](docs/ChunkReqPayload.md)\n - [TrieveRubyClient::ChunkReturnTypes](docs/ChunkReturnTypes.md)\n - [TrieveRubyClient::ClusterAnalytics](docs/ClusterAnalytics.md)\n - [TrieveRubyClient::ClusterAnalyticsFilter](docs/ClusterAnalyticsFilter.md)\n - [TrieveRubyClient::ClusterAnalyticsResponse](docs/ClusterAnalyticsResponse.md)\n - [TrieveRubyClient::ClusterQueries](docs/ClusterQueries.md)\n - [TrieveRubyClient::ClusterTopics](docs/ClusterTopics.md)\n - [TrieveRubyClient::ConditionType](docs/ConditionType.md)\n - [TrieveRubyClient::ContentChunkMetadata](docs/ContentChunkMetadata.md)\n - [TrieveRubyClient::CountChunkQueryResponseBody](docs/CountChunkQueryResponseBody.md)\n - [TrieveRubyClient::CountChunksReqPayload](docs/CountChunksReqPayload.md)\n - [TrieveRubyClient::CountQueries](docs/CountQueries.md)\n - [TrieveRubyClient::CreateChunkGroupReqPayload](docs/CreateChunkGroupReqPayload.md)\n - [TrieveRubyClient::CreateChunkReqPayloadEnum](docs/CreateChunkReqPayloadEnum.md)\n - [TrieveRubyClient::CreateDatasetRequest](docs/CreateDatasetRequest.md)\n - [TrieveRubyClient::CreateMessageReqPayload](docs/CreateMessageReqPayload.md)\n - [TrieveRubyClient::CreateOrganizationData](docs/CreateOrganizationData.md)\n - [TrieveRubyClient::CreateSetupCheckoutSessionResPayload](docs/CreateSetupCheckoutSessionResPayload.md)\n - [TrieveRubyClient::CreateTopicReqPayload](docs/CreateTopicReqPayload.md)\n - [TrieveRubyClient::Dataset](docs/Dataset.md)\n - [TrieveRubyClient::DatasetAnalytics](docs/DatasetAnalytics.md)\n - [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)\n - [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)\n - [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)\n - [TrieveRubyClient::DateRange](docs/DateRange.md)\n - [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)\n - [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)\n - [TrieveRubyClient::DeprecatedSearchOverGroupsResponseBody](docs/DeprecatedSearchOverGroupsResponseBody.md)\n - [TrieveRubyClient::DistancePhrase](docs/DistancePhrase.md)\n - [TrieveRubyClient::EditMessageReqPayload](docs/EditMessageReqPayload.md)\n - [TrieveRubyClient::ErrorResponseBody](docs/ErrorResponseBody.md)\n - [TrieveRubyClient::Event](docs/Event.md)\n - [TrieveRubyClient::EventReturn](docs/EventReturn.md)\n - [TrieveRubyClient::EventTypeRequest](docs/EventTypeRequest.md)\n - [TrieveRubyClient::FieldCondition](docs/FieldCondition.md)\n - [TrieveRubyClient::File](docs/File.md)\n - [TrieveRubyClient::FileDTO](docs/FileDTO.md)\n - [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)\n - [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)\n - [TrieveRubyClient::GeoInfoWithBias](docs/GeoInfoWithBias.md)\n - [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)\n - [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)\n - [TrieveRubyClient::GetChunksForGroupsResponse](docs/GetChunksForGroupsResponse.md)\n - [TrieveRubyClient::GetDatasetsPagination](docs/GetDatasetsPagination.md)\n - [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)\n - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)\n - [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)\n - [TrieveRubyClient::Granularity](docs/Granularity.md)\n - [TrieveRubyClient::GroupData](docs/GroupData.md)\n - [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)\n - [TrieveRubyClient::GroupsBookmarkQueryResult](docs/GroupsBookmarkQueryResult.md)\n - [TrieveRubyClient::HasIDCondition](docs/HasIDCondition.md)\n - [TrieveRubyClient::HeadQueries](docs/HeadQueries.md)\n - [TrieveRubyClient::HeadQueries1](docs/HeadQueries1.md)\n - [TrieveRubyClient::HeadQueryResponse](docs/HeadQueryResponse.md)\n - [TrieveRubyClient::InvitationData](docs/InvitationData.md)\n - [TrieveRubyClient::LatencyGraph](docs/LatencyGraph.md)\n - [TrieveRubyClient::LatencyGraphResponse](docs/LatencyGraphResponse.md)\n - [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)\n - [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)\n - [TrieveRubyClient::LocationRadius](docs/LocationRadius.md)\n - [TrieveRubyClient::LowConfidenceQueries](docs/LowConfidenceQueries.md)\n - [TrieveRubyClient::LowConfidenceRecommendations](docs/LowConfidenceRecommendations.md)\n - [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)\n - [TrieveRubyClient::Message](docs/Message.md)\n - [TrieveRubyClient::NewChunkMetadataTypes](docs/NewChunkMetadataTypes.md)\n - [TrieveRubyClient::NoResultQueries](docs/NoResultQueries.md)\n - [TrieveRubyClient::Organization](docs/Organization.md)\n - [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)\n - [TrieveRubyClient::QueryCountResponse](docs/QueryCountResponse.md)\n - [TrieveRubyClient::QueryDetails](docs/QueryDetails.md)\n - [TrieveRubyClient::RAGAnalytics](docs/RAGAnalytics.md)\n - [TrieveRubyClient::RAGAnalyticsFilter](docs/RAGAnalyticsFilter.md)\n - [TrieveRubyClient::RAGAnalyticsResponse](docs/RAGAnalyticsResponse.md)\n - [TrieveRubyClient::RAGQueries](docs/RAGQueries.md)\n - [TrieveRubyClient::RAGUsage](docs/RAGUsage.md)\n - [TrieveRubyClient::RAGUsageResponse](docs/RAGUsageResponse.md)\n - [TrieveRubyClient::RPSGraph](docs/RPSGraph.md)\n - [TrieveRubyClient::RPSGraphResponse](docs/RPSGraphResponse.md)\n - [TrieveRubyClient::RagQueryEvent](docs/RagQueryEvent.md)\n - [TrieveRubyClient::RagQueryResponse](docs/RagQueryResponse.md)\n - [TrieveRubyClient::RagTypes](docs/RagTypes.md)\n - [TrieveRubyClient::Range](docs/Range.md)\n - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)\n - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)\n - [TrieveRubyClient::RecommendChunksResponseBody](docs/RecommendChunksResponseBody.md)\n - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)\n - [TrieveRubyClient::RecommendGroupsResponse](docs/RecommendGroupsResponse.md)\n - [TrieveRubyClient::RecommendGroupsResponseBody](docs/RecommendGroupsResponseBody.md)\n - [TrieveRubyClient::RecommendResponseTypes](docs/RecommendResponseTypes.md)\n - [TrieveRubyClient::RecommendType](docs/RecommendType.md)\n - [TrieveRubyClient::RecommendationAnalytics](docs/RecommendationAnalytics.md)\n - [TrieveRubyClient::RecommendationAnalyticsFilter](docs/RecommendationAnalyticsFilter.md)\n - [TrieveRubyClient::RecommendationAnalyticsResponse](docs/RecommendationAnalyticsResponse.md)\n - [TrieveRubyClient::RecommendationEvent](docs/RecommendationEvent.md)\n - [TrieveRubyClient::RecommendationQueries](docs/RecommendationQueries.md)\n - [TrieveRubyClient::RecommendationStrategy](docs/RecommendationStrategy.md)\n - [TrieveRubyClient::RecommendationType](docs/RecommendationType.md)\n - [TrieveRubyClient::RecommendationsEventResponse](docs/RecommendationsEventResponse.md)\n - [TrieveRubyClient::RegenerateMessageReqPayload](docs/RegenerateMessageReqPayload.md)\n - [TrieveRubyClient::RemoveChunkFromGroupReqPayload](docs/RemoveChunkFromGroupReqPayload.md)\n - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)\n - [TrieveRubyClient::RoleProxy](docs/RoleProxy.md)\n - [TrieveRubyClient::ScoreChunk](docs/ScoreChunk.md)\n - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)\n - [TrieveRubyClient::SearchAnalytics](docs/SearchAnalytics.md)\n - [TrieveRubyClient::SearchAnalyticsFilter](docs/SearchAnalyticsFilter.md)\n - [TrieveRubyClient::SearchAnalyticsResponse](docs/SearchAnalyticsResponse.md)\n - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)\n - [TrieveRubyClient::SearchChunksReqPayload](docs/SearchChunksReqPayload.md)\n - [TrieveRubyClient::SearchClusterResponse](docs/SearchClusterResponse.md)\n - [TrieveRubyClient::SearchClusterTopics](docs/SearchClusterTopics.md)\n - [TrieveRubyClient::SearchGroupResponseTypes](docs/SearchGroupResponseTypes.md)\n - [TrieveRubyClient::SearchLatencyGraph](docs/SearchLatencyGraph.md)\n - [TrieveRubyClient::SearchMethod](docs/SearchMethod.md)\n - [TrieveRubyClient::SearchMetrics](docs/SearchMetrics.md)\n - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)\n - [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)\n - [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)\n - [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)\n - [TrieveRubyClient::SearchQueries](docs/SearchQueries.md)\n - [TrieveRubyClient::SearchQueryEvent](docs/SearchQueryEvent.md)\n - [TrieveRubyClient::SearchQueryResponse](docs/SearchQueryResponse.md)\n - [TrieveRubyClient::SearchRPSGraph](docs/SearchRPSGraph.md)\n - [TrieveRubyClient::SearchResponseBody](docs/SearchResponseBody.md)\n - [TrieveRubyClient::SearchResponseTypes](docs/SearchResponseTypes.md)\n - [TrieveRubyClient::SearchResultType](docs/SearchResultType.md)\n - [TrieveRubyClient::SearchType](docs/SearchType.md)\n - [TrieveRubyClient::SearchTypeCount](docs/SearchTypeCount.md)\n - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)\n - [TrieveRubyClient::SearchWithinGroupResponseBody](docs/SearchWithinGroupResponseBody.md)\n - [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)\n - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)\n - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)\n - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)\n - [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)\n - [TrieveRubyClient::SlimChunkMetadataWithArrayTagSet](docs/SlimChunkMetadataWithArrayTagSet.md)\n - [TrieveRubyClient::SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)\n - [TrieveRubyClient::SlimUser](docs/SlimUser.md)\n - [TrieveRubyClient::SortBy](docs/SortBy.md)\n - [TrieveRubyClient::SortOrder](docs/SortOrder.md)\n - [TrieveRubyClient::StripeInvoice](docs/StripeInvoice.md)\n - [TrieveRubyClient::StripePlan](docs/StripePlan.md)\n - [TrieveRubyClient::SuggestedQueriesReqPayload](docs/SuggestedQueriesReqPayload.md)\n - [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)\n - [TrieveRubyClient::Topic](docs/Topic.md)\n - [TrieveRubyClient::UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)\n - [TrieveRubyClient::UpdateChunkGroupData](docs/UpdateChunkGroupData.md)\n - [TrieveRubyClient::UpdateChunkReqPayload](docs/UpdateChunkReqPayload.md)\n - [TrieveRubyClient::UpdateDatasetRequest](docs/UpdateDatasetRequest.md)\n - [TrieveRubyClient::UpdateGroupByTrackingIDReqPayload](docs/UpdateGroupByTrackingIDReqPayload.md)\n - [TrieveRubyClient::UpdateOrganizationData](docs/UpdateOrganizationData.md)\n - [TrieveRubyClient::UpdateTopicReqPayload](docs/UpdateTopicReqPayload.md)\n - [TrieveRubyClient::UpdateUserOrgRoleData](docs/UpdateUserOrgRoleData.md)\n - [TrieveRubyClient::UploadFileReqPayload](docs/UploadFileReqPayload.md)\n - [TrieveRubyClient::UploadFileResult](docs/UploadFileResult.md)\n - [TrieveRubyClient::UserOrganization](docs/UserOrganization.md)\n\n\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n### ApiKey\n\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n### X-API-KEY\n\n\n- **Type**: API key\n- **API key parameter name**: X-API-KEY\n- **Location**: HTTP header\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve-ruby-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevflowinc%2Ftrieve-ruby-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve-ruby-client/lists"}