trieve_ruby_client 0.3.5 → 0.5.0

data/docs/MessageApi.md

@@ -1,22 +1,22 @@
 # TrieveRubyClient::MessageApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_message_completion_handler**](MessageApi.md#create_message_completion_handler) | **POST** /api/message | create_message |
-| [**edit_message_handler**](MessageApi.md#edit_message_handler) | **PUT** /api/message | edit_message |
-| [**get_all_topic_messages**](MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | get_all_messages |
-| [**regenerate_message_handler**](MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | regenerate_message |
+| [**create_message_completion_handler**](MessageApi.md#create_message_completion_handler) | **POST** /api/message | Create a message |
+| [**edit_message_handler**](MessageApi.md#edit_message_handler) | **PUT** /api/message | Edit a message |
+| [**get_all_topic_messages**](MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic |
+| [**regenerate_message_handler**](MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | Regenerate message |
 
 
 ## create_message_completion_handler
 
 > String create_message_completion_handler(tr_dataset, create_message_data)
 
-create_message
+Create a message
 
-create_message  Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+Create a message  Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon. Currently, you can only send user messages. If the topic is a RAG topic then the response will include Chunks first on the stream. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
 
 ### Examples
 
@@ -36,7 +36,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 create_message_data = TrieveRubyClient::CreateMessageData.new({new_message_content: 'new_message_content_example', topic_id: 'topic_id_example'}) # CreateMessageData | JSON request payload to create a message completion
 
 begin
-  # create_message
+  # Create a message
   result = api_instance.create_message_completion_handler(tr_dataset, create_message_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -52,7 +52,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # create_message
+  # Create a message
   data, status_code, headers = api_instance.create_message_completion_handler_with_http_info(tr_dataset, create_message_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -87,9 +87,9 @@ end
 
 > edit_message_handler(tr_dataset, edit_message_data)
 
-edit_message
+Edit a message
 
-edit_message  Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+Edit a message  Edit a message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
 
 ### Examples
 
@@ -109,7 +109,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 edit_message_data = TrieveRubyClient::EditMessageData.new({message_sort_order: 37, new_message_content: 'new_message_content_example', topic_id: 'topic_id_example'}) # EditMessageData | JSON request payload to edit a message and get a new stream
 
 begin
-  # edit_message
+  # Edit a message
   api_instance.edit_message_handler(tr_dataset, edit_message_data)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling MessageApi->edit_message_handler: #{e}"
@@ -124,7 +124,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # edit_message
+  # Edit a message
   data, status_code, headers = api_instance.edit_message_handler_with_http_info(tr_dataset, edit_message_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -159,9 +159,9 @@ nil (empty response body)
 
 > <Array<Message>> get_all_topic_messages(tr_dataset, messages_topic_id)
 
-get_all_messages
+Get all messages for a given topic
 
-get_all_messages  Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+Get all messages for a given topic  Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
 
 ### Examples
 
@@ -181,7 +181,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 messages_topic_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The ID of the topic to get messages for.
 
 begin
-  # get_all_messages
+  # Get all messages for a given topic
   result = api_instance.get_all_topic_messages(tr_dataset, messages_topic_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -197,7 +197,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_all_messages
+  # Get all messages for a given topic
   data, status_code, headers = api_instance.get_all_topic_messages_with_http_info(tr_dataset, messages_topic_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -232,9 +232,9 @@ end
 
 > String regenerate_message_handler(tr_dataset, regenerate_message_data)
 
-regenerate_message
+Regenerate message
 
-regenerate_message  Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
+Regenerate message  Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
 
 ### Examples
 
@@ -254,7 +254,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 regenerate_message_data = TrieveRubyClient::RegenerateMessageData.new({topic_id: 'topic_id_example'}) # RegenerateMessageData | JSON request payload to delete an agent message then regenerate it in a strem
 
 begin
-  # regenerate_message
+  # Regenerate message
   result = api_instance.regenerate_message_handler(tr_dataset, regenerate_message_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -270,7 +270,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # regenerate_message
+  # Regenerate message
   data, status_code, headers = api_instance.regenerate_message_handler_with_http_info(tr_dataset, regenerate_message_data)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/OrganizationApi.md

@@ -1,24 +1,24 @@
 # TrieveRubyClient::OrganizationApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_organization**](OrganizationApi.md#create_organization) | **POST** /api/organization | create_organization |
-| [**delete_organization_by_id**](OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | delete_organization |
-| [**get_organization_by_id**](OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | get_organization |
-| [**get_organization_usage**](OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | get_organization_usage |
-| [**get_organization_users**](OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | get_organization_users |
-| [**update_organization**](OrganizationApi.md#update_organization) | **PUT** /api/organization | update_organization |
+| [**create_organization**](OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization |
+| [**delete_organization_by_id**](OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete Organization |
+| [**get_organization_by_id**](OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | Get Organization |
+| [**get_organization_usage**](OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage |
+| [**get_organization_users**](OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users |
+| [**update_organization**](OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization |
 
 
 ## create_organization
 
 > <Organization> create_organization(create_organization_data)
 
-create_organization
+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 Organization  Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
 
 ### Examples
 
@@ -37,7 +37,7 @@ api_instance = TrieveRubyClient::OrganizationApi.new
 create_organization_data = TrieveRubyClient::CreateOrganizationData.new({name: 'name_example'}) # CreateOrganizationData | The organization data that you want to create
 
 begin
-  # create_organization
+  # Create Organization
   result = api_instance.create_organization(create_organization_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -53,7 +53,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # create_organization
+  # Create Organization
   data, status_code, headers = api_instance.create_organization_with_http_info(create_organization_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -87,9 +87,9 @@ end
 
 > <Organization> delete_organization_by_id(tr_organization, organization_id)
 
-delete_organization
+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 Organization  Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
 
 ### Examples
 
@@ -109,7 +109,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch.
 
 begin
-  # delete_organization
+  # Delete Organization
   result = api_instance.delete_organization_by_id(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -125,7 +125,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # delete_organization
+  # Delete Organization
   data, status_code, headers = api_instance.delete_organization_by_id_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -160,9 +160,9 @@ end
 
 > <Organization> get_organization_by_id(tr_organization, organization_id)
 
-get_organization
+Get Organization
 
-get_organization  Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
+Get Organization  Fetch the details of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
 
 ### Examples
 
@@ -182,7 +182,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch.
 
 begin
-  # get_organization
+  # Get Organization
   result = api_instance.get_organization_by_id(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -198,7 +198,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization
+  # Get Organization
   data, status_code, headers = api_instance.get_organization_by_id_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -233,9 +233,9 @@ end
 
 > <OrganizationUsageCount> get_organization_usage(tr_organization, organization_id)
 
-get_organization_usage
+Get Organization Usage
 
-get_organization_usage  Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
+Get Organization Usage  Fetch the current usage specification of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
 
 ### Examples
 
@@ -255,7 +255,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch the usage of.
 
 begin
-  # get_organization_usage
+  # Get Organization Usage
   result = api_instance.get_organization_usage(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -271,7 +271,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization_usage
+  # Get Organization Usage
   data, status_code, headers = api_instance.get_organization_usage_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -306,9 +306,9 @@ end
 
 > <Array<SlimUser>> get_organization_users(tr_organization, organization_id)
 
-get_organization_users
+Get Organization Users
 
-get_organization_users  Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
+Get Organization Users  Fetch the users of an organization by its id. The auth'ed user must be an admin or owner of the organization to fetch it.
 
 ### Examples
 
@@ -328,7 +328,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization you want to fetch the users of.
 
 begin
-  # get_organization_users
+  # Get Organization Users
   result = api_instance.get_organization_users(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -344,7 +344,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization_users
+  # Get Organization Users
   data, status_code, headers = api_instance.get_organization_users_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -379,9 +379,9 @@ end
 
 > <Organization> update_organization(tr_organization, update_organization_data)
 
-update_organization
+Update Organization
 
-update_organization  Update an organization. Only the owner of the organization can update it.
+Update Organization  Update an organization. Only the owner of the organization can update it.
 
 ### Examples
 
@@ -401,7 +401,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 update_organization_data = TrieveRubyClient::UpdateOrganizationData.new({organization_id: 'organization_id_example'}) # UpdateOrganizationData | The organization data that you want to update
 
 begin
-  # update_organization
+  # Update Organization
   result = api_instance.update_organization(tr_organization, update_organization_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -417,7 +417,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # update_organization
+  # Update Organization
   data, status_code, headers = api_instance.update_organization_with_http_info(tr_organization, update_organization_data)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/ReturnQueuedChunk.md

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

data/docs/SingleQueuedChunkResponse.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::SingleQueuedChunkResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_metadata** | [**ChunkMetadata**](ChunkMetadata.md) |  |  |
+| **pos_in_queue** | **Integer** | The current position the last access item is in the queue |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SingleQueuedChunkResponse.new(
+  chunk_metadata: null,
+  pos_in_queue: null
+)
+```
+

data/docs/StripeApi.md

@@ -1,20 +1,22 @@
 # TrieveRubyClient::StripeApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} |  |
-| [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} |  |
-| [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans |  |
-| [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} |  |
+| [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription |
+| [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout |
+| [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans |
+| [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan |
 
 
 ## cancel_subscription
 
 > cancel_subscription(tr_organization, subscription_id)
 
+Cancel Subscription
 
+Cancel Subscription  Cancel a subscription by its id
 
 ### Examples
 
@@ -34,7 +36,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the subscription you want to cancel
 
 begin
-  
+  # Cancel Subscription
   api_instance.cancel_subscription(tr_organization, subscription_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling StripeApi->cancel_subscription: #{e}"
@@ -49,7 +51,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Cancel Subscription
   data, status_code, headers = api_instance.cancel_subscription_with_http_info(tr_organization, subscription_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -84,7 +86,9 @@ nil (empty response body)
 
 > direct_to_payment_link(plan_id, organization_id)
 
+Checkout
 
+Checkout  Get a direct link to the stripe checkout page for the plan and organization
 
 ### Examples
 
@@ -97,7 +101,7 @@ plan_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the plan you w
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the organization you want to subscribe to the plan
 
 begin
-  
+  # Checkout
   api_instance.direct_to_payment_link(plan_id, organization_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling StripeApi->direct_to_payment_link: #{e}"
@@ -112,7 +116,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Checkout
   data, status_code, headers = api_instance.direct_to_payment_link_with_http_info(plan_id, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -147,7 +151,9 @@ No authorization required
 
 > <Array<StripePlan>> get_all_plans
 
+Get All Plans
 
+Get All Plans  Get a list of all plans
 
 ### Examples
 
@@ -158,7 +164,7 @@ require 'trieve_ruby_client'
 api_instance = TrieveRubyClient::StripeApi.new
 
 begin
-  
+  # Get All Plans
   result = api_instance.get_all_plans
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -174,7 +180,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Get All Plans
   data, status_code, headers = api_instance.get_all_plans_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -206,7 +212,9 @@ No authorization required
 
 > update_subscription_plan(tr_organization, subscription_id, plan_id)
 
+Update Subscription Plan
 
+Update Subscription Plan  Update a subscription to a new plan
 
 ### Examples
 
@@ -227,7 +235,7 @@ subscription_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the su
 plan_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the plan you want to subscribe to
 
 begin
-  
+  # Update Subscription Plan
   api_instance.update_subscription_plan(tr_organization, subscription_id, plan_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling StripeApi->update_subscription_plan: #{e}"
@@ -242,7 +250,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Update Subscription Plan
   data, status_code, headers = api_instance.update_subscription_plan_with_http_info(tr_organization, subscription_id, plan_id)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/TopicApi.md

@@ -1,22 +1,22 @@
 # TrieveRubyClient::TopicApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | create_topic |
-| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | delete_topic |
-| [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | get_all_topics_for_user |
-| [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | update_topic |
+| [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | Create Topic |
+| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic |
+| [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User |
+| [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic |
 
 
 ## create_topic
 
 > <Topic> create_topic(tr_dataset, create_topic_data)
 
-create_topic
+Create Topic
 
-create_topic  Create a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.
+Create Topic  Create a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.
 
 ### Examples
 
@@ -36,7 +36,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 create_topic_data = TrieveRubyClient::CreateTopicData.new # CreateTopicData | JSON request payload to create chat topic
 
 begin
-  # create_topic
+  # Create Topic
   result = api_instance.create_topic(tr_dataset, create_topic_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -52,7 +52,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # create_topic
+  # Create Topic
   data, status_code, headers = api_instance.create_topic_with_http_info(tr_dataset, create_topic_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -87,9 +87,9 @@ end
 
 > delete_topic(tr_dataset, delete_topic_data)
 
-delete_topic
+Delete Topic
 
-delete_topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
+Delete Topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
 
 ### Examples
 
@@ -109,7 +109,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 delete_topic_data = TrieveRubyClient::DeleteTopicData.new({topic_id: 'topic_id_example'}) # DeleteTopicData | JSON request payload to delete a chat topic
 
 begin
-  # delete_topic
+  # Delete Topic
   api_instance.delete_topic(tr_dataset, delete_topic_data)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling TopicApi->delete_topic: #{e}"
@@ -124,7 +124,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # delete_topic
+  # Delete Topic
   data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset, delete_topic_data)
   p status_code # => 2xx
   p headers # => { ... }
@@ -159,9 +159,9 @@ nil (empty response body)
 
 > <Array<Topic>> get_all_topics_for_user(user_id, tr_dataset)
 
-get_all_topics_for_user
+Get All Topics for User
 
-get_all_topics_for_user  Get all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.
+Get All Topics for User  Get all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.
 
 ### Examples
 
@@ -181,7 +181,7 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the user t
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 
 begin
-  # get_all_topics_for_user
+  # Get All Topics for User
   result = api_instance.get_all_topics_for_user(user_id, tr_dataset)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -197,7 +197,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_all_topics_for_user
+  # Get All Topics for User
   data, status_code, headers = api_instance.get_all_topics_for_user_with_http_info(user_id, tr_dataset)
   p status_code # => 2xx
   p headers # => { ... }
@@ -232,9 +232,9 @@ end
 
 > update_topic(tr_dataset, update_topic_data)
 
-update_topic
+Update Topic
 
-update_topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
+Update Topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
 
 ### Examples
 
@@ -254,7 +254,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 update_topic_data = TrieveRubyClient::UpdateTopicData.new({name: 'name_example', topic_id: 'topic_id_example'}) # UpdateTopicData | JSON request payload to update a chat topic
 
 begin
-  # update_topic
+  # Update Topic
   api_instance.update_topic(tr_dataset, update_topic_data)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling TopicApi->update_topic: #{e}"
@@ -269,7 +269,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # update_topic
+  # Update Topic
   data, status_code, headers = api_instance.update_topic_with_http_info(tr_dataset, update_topic_data)
   p status_code # => 2xx
   p headers # => { ... }