trieve_ruby_client 0.3.4

data/docs/InvitationApi.md

@@ -0,0 +1,85 @@
+# TrieveRubyClient::InvitationApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**post_invitation**](InvitationApi.md#post_invitation) | **POST** /api/invitation | send_invitation |
+
+
+## post_invitation
+
+> post_invitation(tr_organization, invitation_data)
+
+send_invitation
+
+send_invitation  Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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::InvitationApi.new
+tr_organization = 'tr_organization_example' # String | The organization id to use for the request
+invitation_data = TrieveRubyClient::InvitationData.new({app_url: 'app_url_example', email: 'email_example', organization_id: 'organization_id_example', redirect_uri: 'redirect_uri_example', user_role: 37}) # InvitationData | JSON request payload to send an invitation
+
+begin
+  # send_invitation
+  api_instance.post_invitation(tr_organization, invitation_data)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling InvitationApi->post_invitation: #{e}"
+end
+```
+
+#### Using the post_invitation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_invitation_with_http_info(tr_organization, invitation_data)
+
+```ruby
+begin
+  # send_invitation
+  data, status_code, headers = api_instance.post_invitation_with_http_info(tr_organization, invitation_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling InvitationApi->post_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_organization** | **String** | The organization id to use for the request |  |
+| **invitation_data** | [**InvitationData**](InvitationData.md) | JSON request payload to send an invitation |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InvitationData.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::InvitationData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_url** | **String** | The url of the app that the user will be directed to in order to set their password. Usually admin.trieve.ai, but may differ for local dev or self-hosted setups. |  |
+| **email** | **String** | The email of the user to invite. Must be a valid email as they will be sent an email to register. |  |
+| **organization_id** | **String** | The id of the organization to invite the user to. |  |
+| **redirect_uri** | **String** | The url that the user will be redirected to after setting their password. |  |
+| **user_role** | **Integer** | The role the user will have in the organization. 0 = User, 1 = Admin, 2 = Owner. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::InvitationData.new(
+  app_url: null,
+  email: null,
+  organization_id: null,
+  redirect_uri: null,
+  user_role: null
+)
+```
+

data/docs/MatchCondition.md

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

data/docs/Message.md

@@ -0,0 +1,38 @@
+# TrieveRubyClient::Message
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completion_tokens** | **Integer** |  | [optional] |
+| **content** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **id** | **String** |  |  |
+| **prompt_tokens** | **Integer** |  | [optional] |
+| **role** | **String** |  |  |
+| **sort_order** | **Integer** |  |  |
+| **topic_id** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::Message.new(
+  completion_tokens: null,
+  content: null,
+  created_at: null,
+  dataset_id: null,
+  deleted: null,
+  id: null,
+  prompt_tokens: null,
+  role: null,
+  sort_order: null,
+  topic_id: null,
+  updated_at: null
+)
+```
+

data/docs/MessageApi.md

@@ -0,0 +1,322 @@
+# TrieveRubyClient::MessageApi
+
+All URIs are relative to *http://localhost*
+
+| 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
+
+> String create_message_completion_handler(tr_dataset, create_message_data)
+
+create_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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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::MessageApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+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
+  result = api_instance.create_message_completion_handler(tr_dataset, create_message_data)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->create_message_completion_handler: #{e}"
+end
+```
+
+#### Using the create_message_completion_handler_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> create_message_completion_handler_with_http_info(tr_dataset, create_message_data)
+
+```ruby
+begin
+  # create_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 # => { ... }
+  p data # => String
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->create_message_completion_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **create_message_data** | [**CreateMessageData**](CreateMessageData.md) | JSON request payload to create a message completion |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/plain, application/json
+
+
+## edit_message_handler
+
+> edit_message_handler(tr_dataset, edit_message_data)
+
+edit_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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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::MessageApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+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
+  api_instance.edit_message_handler(tr_dataset, edit_message_data)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->edit_message_handler: #{e}"
+end
+```
+
+#### Using the edit_message_handler_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> edit_message_handler_with_http_info(tr_dataset, edit_message_data)
+
+```ruby
+begin
+  # edit_message
+  data, status_code, headers = api_instance.edit_message_handler_with_http_info(tr_dataset, edit_message_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->edit_message_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **edit_message_data** | [**EditMessageData**](EditMessageData.md) | JSON request payload to edit a message and get a new stream |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_all_topic_messages
+
+> <Array<Message>> get_all_topic_messages(tr_dataset, messages_topic_id)
+
+get_all_messages
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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::MessageApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+messages_topic_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The ID of the topic to get messages for.
+
+begin
+  # get_all_messages
+  result = api_instance.get_all_topic_messages(tr_dataset, messages_topic_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->get_all_topic_messages: #{e}"
+end
+```
+
+#### Using the get_all_topic_messages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Message>>, Integer, Hash)> get_all_topic_messages_with_http_info(tr_dataset, messages_topic_id)
+
+```ruby
+begin
+  # get_all_messages
+  data, status_code, headers = api_instance.get_all_topic_messages_with_http_info(tr_dataset, messages_topic_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Message>>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->get_all_topic_messages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **messages_topic_id** | **String** | The ID of the topic to get messages for. |  |
+
+### Return type
+
+[**Array&lt;Message&gt;**](Message.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## regenerate_message_handler
+
+> String regenerate_message_handler(tr_dataset, regenerate_message_data)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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::MessageApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+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
+  result = api_instance.regenerate_message_handler(tr_dataset, regenerate_message_data)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->regenerate_message_handler: #{e}"
+end
+```
+
+#### Using the regenerate_message_handler_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> regenerate_message_handler_with_http_info(tr_dataset, regenerate_message_data)
+
+```ruby
+begin
+  # 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 # => { ... }
+  p data # => String
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling MessageApi->regenerate_message_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **regenerate_message_data** | [**RegenerateMessageData**](RegenerateMessageData.md) | JSON request payload to delete an agent message then regenerate it in a strem |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/plain, application/json
+

data/docs/Organization.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::Organization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **registerable** | **Boolean** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::Organization.new(
+  created_at: null,
+  id: null,
+  name: null,
+  registerable: null,
+  updated_at: null
+)
+```
+