trieve_ruby_client 0.3.4

data/docs/EventsApi.md

@@ -0,0 +1,86 @@
+# TrieveRubyClient::EventsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_events**](EventsApi.md#get_events) | **GET** /api/events/{page} | get_events |
+
+
+## get_events
+
+> <EventReturn> get_events(tr_dataset, page)
+
+get_events
+
+get_events  Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users. Each page contains 10 events.
+
+### 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::EventsApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+page = 789 # Integer | Page number of events to get
+
+begin
+  # get_events
+  result = api_instance.get_events(tr_dataset, page)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling EventsApi->get_events: #{e}"
+end
+```
+
+#### Using the get_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventReturn>, Integer, Hash)> get_events_with_http_info(tr_dataset, page)
+
+```ruby
+begin
+  # get_events
+  data, status_code, headers = api_instance.get_events_with_http_info(tr_dataset, page)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventReturn>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling EventsApi->get_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **page** | **Integer** | Page number of events to get |  |
+
+### Return type
+
+[**EventReturn**](EventReturn.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FieldCondition.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::FieldCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Field is the name of the field to filter on. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. |  |
+| **match** | [**Array<MatchCondition>**](MatchCondition.md) | Match is the value to match on the field. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. | [optional] |
+| **range** | [**Range**](Range.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::FieldCondition.new(
+  field: null,
+  match: null,
+  range: null
+)
+```
+

data/docs/File.md

@@ -0,0 +1,36 @@
+# TrieveRubyClient::File
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **file_name** | **String** |  |  |
+| **id** | **String** |  |  |
+| **link** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **size** | **Integer** |  |  |
+| **tag_set** | **String** |  | [optional] |
+| **time_stamp** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::File.new(
+  created_at: null,
+  dataset_id: null,
+  file_name: null,
+  id: null,
+  link: null,
+  metadata: null,
+  size: null,
+  tag_set: null,
+  time_stamp: null,
+  updated_at: null
+)
+```
+

data/docs/FileApi.md

@@ -0,0 +1,326 @@
+# TrieveRubyClient::FileApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_file_handler**](FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | delete_file |
+| [**get_dataset_files_handler**](FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | get_dataset_files |
+| [**get_file_handler**](FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | get_file |
+| [**upload_file_handler**](FileApi.md#upload_file_handler) | **POST** /api/file | upload_file |
+
+
+## delete_file_handler
+
+> delete_file_handler(tr_dataset, file_id, delete_chunks)
+
+delete_file
+
+delete_file  Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
+
+### 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::FileApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the file to delete
+delete_chunks = true # Boolean | Whether or not to delete the chunks associated with the file
+
+begin
+  # delete_file
+  api_instance.delete_file_handler(tr_dataset, file_id, delete_chunks)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->delete_file_handler: #{e}"
+end
+```
+
+#### Using the delete_file_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)> delete_file_handler_with_http_info(tr_dataset, file_id, delete_chunks)
+
+```ruby
+begin
+  # delete_file
+  data, status_code, headers = api_instance.delete_file_handler_with_http_info(tr_dataset, file_id, delete_chunks)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->delete_file_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **file_id** | **String** | The id of the file to delete |  |
+| **delete_chunks** | **Boolean** | Whether or not to delete the chunks associated with the file |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_dataset_files_handler
+
+> Array&lt;File&gt; get_dataset_files_handler(tr_dataset, dataset_id, page)
+
+get_dataset_files
+
+get_dataset_files  Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
+
+### 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::FileApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset to fetch files for.
+page = 789 # Integer | The page number of files you wish to fetch. Each page contains at most 10 files.
+
+begin
+  # get_dataset_files
+  result = api_instance.get_dataset_files_handler(tr_dataset, dataset_id, page)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->get_dataset_files_handler: #{e}"
+end
+```
+
+#### Using the get_dataset_files_handler_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;File&gt;, Integer, Hash)> get_dataset_files_handler_with_http_info(tr_dataset, dataset_id, page)
+
+```ruby
+begin
+  # get_dataset_files
+  data, status_code, headers = api_instance.get_dataset_files_handler_with_http_info(tr_dataset, dataset_id, page)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;File&gt;
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->get_dataset_files_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **dataset_id** | **String** | The id of the dataset to fetch files for. |  |
+| **page** | **Integer** | The page number of files you wish to fetch. Each page contains at most 10 files. |  |
+
+### Return type
+
+**Array&lt;File&gt;**
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_file_handler
+
+> <FileDTO> get_file_handler(tr_dataset, file_id)
+
+get_file
+
+get_file  Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
+
+### 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::FileApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the file to fetch
+
+begin
+  # get_file
+  result = api_instance.get_file_handler(tr_dataset, file_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->get_file_handler: #{e}"
+end
+```
+
+#### Using the get_file_handler_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileDTO>, Integer, Hash)> get_file_handler_with_http_info(tr_dataset, file_id)
+
+```ruby
+begin
+  # get_file
+  data, status_code, headers = api_instance.get_file_handler_with_http_info(tr_dataset, file_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileDTO>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->get_file_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **file_id** | **String** | The id of the file to fetch |  |
+
+### Return type
+
+[**FileDTO**](FileDTO.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## upload_file_handler
+
+> <UploadFileResult> upload_file_handler(tr_dataset, upload_file_data)
+
+upload_file
+
+upload_file  Upload a file to S3 attached to the server. The file will be converted to HTML with tika and chunked algorithmically, images will be OCR'ed with tesseract. The resulting chunks will be indexed and searchable. Optionally, you can only upload the file and manually create chunks associated to the file after. See docs.trieve.ai and/or contact us for more details and tips. Auth'ed user must be an admin or owner of the dataset's organization to upload a file.
+
+### 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::FileApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+upload_file_data = TrieveRubyClient::UploadFileData.new({base64_file: 'base64_file_example', file_mime_type: 'file_mime_type_example', file_name: 'file_name_example'}) # UploadFileData | JSON request payload to upload a file
+
+begin
+  # upload_file
+  result = api_instance.upload_file_handler(tr_dataset, upload_file_data)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->upload_file_handler: #{e}"
+end
+```
+
+#### Using the upload_file_handler_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UploadFileResult>, Integer, Hash)> upload_file_handler_with_http_info(tr_dataset, upload_file_data)
+
+```ruby
+begin
+  # upload_file
+  data, status_code, headers = api_instance.upload_file_handler_with_http_info(tr_dataset, upload_file_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UploadFileResult>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling FileApi->upload_file_handler_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **upload_file_data** | [**UploadFileData**](UploadFileData.md) | JSON request payload to upload a file |  |
+
+### Return type
+
+[**UploadFileResult**](UploadFileResult.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FileDTO.md

@@ -0,0 +1,32 @@
+# TrieveRubyClient::FileDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **file_name** | **String** |  |  |
+| **id** | **String** |  |  |
+| **link** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **s3_url** | **String** |  |  |
+| **size** | **Integer** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::FileDTO.new(
+  created_at: null,
+  file_name: null,
+  id: null,
+  link: null,
+  metadata: null,
+  s3_url: null,
+  size: null,
+  updated_at: null
+)
+```
+

data/docs/GenerateChunksRequest.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::GenerateChunksRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_ids** | **Array<String>** | The ids of the chunks to be retrieved and injected into the context window for RAG. |  |
+| **model** | **String** | The model to use for the chat. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used. | [optional] |
+| **prev_messages** | [**Array<ChatMessageProxy>**](ChatMessageProxy.md) | The previous messages to be placed into the chat history. The last message in this array will be the prompt for the model to inference on. The length of this array must be at least 1. |  |
+| **prompt** | **String** | Prompt for the last message in the prev_messages array. This will be used to generate the next message in the chat. The default is 'Respond to the instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:'. You can also specify an empty string to leave the final message alone such that your user's final message can be used as the prompt. See docs.trieve.ai or contact us for more information. | [optional] |
+| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::GenerateChunksRequest.new(
+  chunk_ids: null,
+  model: null,
+  prev_messages: null,
+  prompt: null,
+  stream_response: null
+)
+```
+

data/docs/GetGroupsForChunksData.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::GetGroupsForChunksData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_ids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::GetGroupsForChunksData.new(
+  chunk_ids: null
+)
+```
+

data/docs/GroupData.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::GroupData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **groups** | [**Array<ChunkGroupAndFile>**](ChunkGroupAndFile.md) |  |  |
+| **total_pages** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::GroupData.new(
+  groups: null,
+  total_pages: null
+)
+```
+

data/docs/GroupScoreChunkDTO.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::GroupScoreChunkDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group_id** | **String** |  |  |
+| **metadata** | [**Array<ScoreChunkDTO>**](ScoreChunkDTO.md) |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::GroupScoreChunkDTO.new(
+  group_id: null,
+  metadata: null
+)
+```
+

data/docs/HealthApi.md

@@ -0,0 +1,66 @@
+# TrieveRubyClient::HealthApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**health_check**](HealthApi.md#health_check) | **GET** /api/health |  |
+
+
+## health_check
+
+> health_check
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::HealthApi.new
+
+begin
+  
+  api_instance.health_check
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling HealthApi->health_check: #{e}"
+end
+```
+
+#### Using the health_check_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)> health_check_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.health_check_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling HealthApi->health_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+