trieve_ruby_client 0.3.5 → 0.4.0

data/docs/CreateChunkData.md

@@ -1,42 +1,49 @@
 # TrieveRubyClient::CreateChunkData
 
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **chunk_html** | **String** | HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. | [optional] |
-| **chunk_vector** | **Array<Float>** | Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding. | [optional] |
-| **file_id** | **String** | File_uuid is the uuid of the file that the chunk is associated with. This is used to associate chunks with files. This is useful for when you want to delete a file and all of its associated chunks. | [optional] |
-| **group_ids** | **Array<String>** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] |
-| **group_tracking_ids** | **Array<String>** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [optional] |
-| **link** | **String** | Link to the chunk. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. | [optional] |
-| **metadata** | **Object** | Metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. | [optional] |
-| **split_avg** | **Boolean** | Split avg is a boolean which tells the server to split the text in the chunk_html into smaller chunks and average their resulting vectors. This is useful for when you want to create a chunk from a large piece of text and want to split it into smaller chunks to create a more fuzzy average dense vector. The sparse vector will be generated normally with no averaging. By default this is false. | [optional] |
-| **tag_set** | **Array<String>** | Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. | [optional] |
-| **time_stamp** | **String** | Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. | [optional] |
-| **tracking_id** | **String** | Tracking_id is a string which can be used to identify a chunk. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. | [optional] |
-| **upsert_by_tracking_id** | **Boolean** | Upsert when a chunk with the same tracking_id exists. By default this is false, and the request will fail if a chunk with the same tracking_id exists. If this is true, the chunk will be updated if a chunk with the same tracking_id exists. | [optional] |
-| **weight** | **Float** | Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset. | [optional] |
-
-## Example
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::CreateChunkData.openapi_one_of
+# =>
+# [
+#   :'Array<ChunkData>',
+#   :'ChunkData'
+# ]
+```
+
+### 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::CreateChunkData.new(
-  chunk_html: null,
-  chunk_vector: null,
-  file_id: null,
-  group_ids: null,
-  group_tracking_ids: null,
-  link: null,
-  metadata: null,
-  split_avg: null,
-  tag_set: null,
-  time_stamp: null,
-  tracking_id: null,
-  upsert_by_tracking_id: null,
-  weight: null
-)
+TrieveRubyClient::CreateChunkData.build(data)
+# => #<Array<ChunkData>:0x00007fdd4aab02a0>
+
+TrieveRubyClient::CreateChunkData.build(data_that_doesnt_match)
+# => nil
 ```
 
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<ChunkData>`
+- `ChunkData`
+- `nil` (if no type matches)
+

data/docs/DatasetApi.md

@@ -1,24 +1,24 @@
 # TrieveRubyClient::DatasetApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | create_dataset |
-| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | delete_dataset |
-| [**get_client_dataset_config**](DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | get_client_dataset_config |
-| [**get_dataset**](DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | get_dataset |
-| [**get_datasets_from_organization**](DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | get_organization_datasets |
-| [**update_dataset**](DatasetApi.md#update_dataset) | **PUT** /api/dataset | update_dataset |
+| [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset |
+| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset |
+| [**get_client_dataset_config**](DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration |
+| [**get_dataset**](DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset |
+| [**get_datasets_from_organization**](DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization |
+| [**update_dataset**](DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset |
 
 
 ## create_dataset
 
 > <Dataset> create_dataset(tr_organization, create_dataset_request)
 
-create_dataset
+Create dataset
 
-create_dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
+Create dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
 
 ### Examples
 
@@ -38,7 +38,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 create_dataset_request = TrieveRubyClient::CreateDatasetRequest.new({client_configuration: 3.56, dataset_name: 'dataset_name_example', organization_id: 'organization_id_example', server_configuration: 3.56}) # CreateDatasetRequest | JSON request payload to create a new dataset
 
 begin
-  # create_dataset
+  # Create dataset
   result = api_instance.create_dataset(tr_organization, create_dataset_request)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -54,7 +54,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # create_dataset
+  # Create dataset
   data, status_code, headers = api_instance.create_dataset_with_http_info(tr_organization, create_dataset_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -89,9 +89,9 @@ end
 
 > delete_dataset(tr_organization, delete_dataset_request)
 
-delete_dataset
+Delete Dataset
 
-delete_dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
+Delete Dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
 
 ### Examples
 
@@ -111,7 +111,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 delete_dataset_request = TrieveRubyClient::DeleteDatasetRequest.new({dataset_id: 'dataset_id_example'}) # DeleteDatasetRequest | JSON request payload to delete a dataset
 
 begin
-  # delete_dataset
+  # Delete Dataset
   api_instance.delete_dataset(tr_organization, delete_dataset_request)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling DatasetApi->delete_dataset: #{e}"
@@ -126,7 +126,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # delete_dataset
+  # Delete Dataset
   data, status_code, headers = api_instance.delete_dataset_with_http_info(tr_organization, delete_dataset_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -161,9 +161,9 @@ nil (empty response body)
 
 > <ClientDatasetConfiguration> get_client_dataset_config(tr_dataset)
 
-get_client_dataset_config
+Get Client Configuration
 
-get_client_dataset_config  Get the client configuration for a dataset. Will use the TR-D
+Get Client Configuration  Get the client configuration for a dataset. Will use the TR-D
 
 ### Examples
 
@@ -182,7 +182,7 @@ api_instance = TrieveRubyClient::DatasetApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 
 begin
-  # get_client_dataset_config
+  # Get Client Configuration
   result = api_instance.get_client_dataset_config(tr_dataset)
   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_client_dataset_config
+  # Get Client Configuration
   data, status_code, headers = api_instance.get_client_dataset_config_with_http_info(tr_dataset)
   p status_code # => 2xx
   p headers # => { ... }
@@ -232,9 +232,9 @@ end
 
 > <Dataset> get_dataset(tr_organization, tr_dataset, dataset_id)
 
-get_dataset
+Get Dataset
 
-get_dataset  Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
+Get Dataset  Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
 
 ### Examples
 
@@ -255,7 +255,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to retrieve.
 
 begin
-  # get_dataset
+  # Get Dataset
   result = api_instance.get_dataset(tr_organization, tr_dataset, dataset_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_dataset
+  # Get Dataset
   data, status_code, headers = api_instance.get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -307,9 +307,9 @@ end
 
 > <Array<DatasetAndUsage>> get_datasets_from_organization(tr_organization, organization_id)
 
-get_organization_datasets
+Get Datasets from Organization
 
-get_organization_datasets  Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
+Get Datasets from Organization  Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
 
 ### Examples
 
@@ -329,7 +329,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the organization you want to retrieve datasets for
 
 begin
-  # get_organization_datasets
+  # Get Datasets from Organization
   result = api_instance.get_datasets_from_organization(tr_organization, organization_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -345,7 +345,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_organization_datasets
+  # Get Datasets from Organization
   data, status_code, headers = api_instance.get_datasets_from_organization_with_http_info(tr_organization, organization_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -380,9 +380,9 @@ end
 
 > <Dataset> update_dataset(tr_organization, update_dataset_request)
 
-update_dataset
+Update Dataset
 
-update_dataset  Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
+Update Dataset  Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
 
 ### Examples
 
@@ -402,7 +402,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 update_dataset_request = TrieveRubyClient::UpdateDatasetRequest.new({dataset_id: 'dataset_id_example'}) # UpdateDatasetRequest | JSON request payload to update a dataset
 
 begin
-  # update_dataset
+  # Update Dataset
   result = api_instance.update_dataset(tr_organization, update_dataset_request)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -418,7 +418,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # update_dataset
+  # Update Dataset
   data, status_code, headers = api_instance.update_dataset_with_http_info(tr_organization, update_dataset_request)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/EventsApi.md

@@ -1,19 +1,19 @@
 # TrieveRubyClient::EventsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_events**](EventsApi.md#get_events) | **GET** /api/events/{page} | get_events |
+| [**get_events**](EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset |
 
 
 ## get_events
 
-> <EventReturn> get_events(tr_dataset, page)
+> <EventReturn> get_events(tr_dataset, get_events_data)
 
-get_events
+Get events for the dataset
 
-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.
+Get events for the dataset  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.
 
 ### Examples
 
@@ -30,11 +30,11 @@ 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
+get_events_data = TrieveRubyClient::GetEventsData.new # GetEventsData | JSON request payload to get events for a dataset
 
 begin
-  # get_events
-  result = api_instance.get_events(tr_dataset, page)
+  # Get events for the dataset
+  result = api_instance.get_events(tr_dataset, get_events_data)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling EventsApi->get_events: #{e}"
@@ -45,12 +45,12 @@ end
 
 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)
+> <Array(<EventReturn>, Integer, Hash)> get_events_with_http_info(tr_dataset, get_events_data)
 
 ```ruby
 begin
-  # get_events
-  data, status_code, headers = api_instance.get_events_with_http_info(tr_dataset, page)
+  # Get events for the dataset
+  data, status_code, headers = api_instance.get_events_with_http_info(tr_dataset, get_events_data)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <EventReturn>
@@ -64,7 +64,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **page** | **Integer** | Page number of events to get |  |
+| **get_events_data** | [**GetEventsData**](GetEventsData.md) | JSON request payload to get events for a dataset |  |
 
 ### Return type
 
@@ -76,6 +76,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 

data/docs/FileApi.md

@@ -1,22 +1,22 @@
 # TrieveRubyClient::FileApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | 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**](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 Files for Dataset |
+| [**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_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.
+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
 
@@ -37,7 +37,7 @@ file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the file t
 delete_chunks = true # Boolean | Whether or not to delete the chunks associated with the file
 
 begin
-  # delete_file
+  # 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}"
@@ -52,7 +52,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # delete_file
+  # 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 # => { ... }
@@ -88,9 +88,9 @@ nil (empty response body)
 
 > Array<File> get_dataset_files_handler(tr_dataset, dataset_id, page)
 
-get_dataset_files
+Get Files for Dataset
 
-get_dataset_files  Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
+Get Files for Dataset  Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
 
 ### Examples
 
@@ -111,7 +111,7 @@ dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dat
 page = 789 # Integer | The page number of files you wish to fetch. Each page contains at most 10 files.
 
 begin
-  # get_dataset_files
+  # Get Files for Dataset
   result = api_instance.get_dataset_files_handler(tr_dataset, dataset_id, page)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -127,7 +127,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_dataset_files
+  # Get Files for Dataset
   data, status_code, headers = api_instance.get_dataset_files_handler_with_http_info(tr_dataset, dataset_id, page)
   p status_code # => 2xx
   p headers # => { ... }
@@ -163,9 +163,9 @@ end
 
 > <FileDTO> get_file_handler(tr_dataset, file_id)
 
-get_file
+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.
+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
 
@@ -185,7 +185,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 file_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the file to fetch
 
 begin
-  # get_file
+  # Get File
   result = api_instance.get_file_handler(tr_dataset, file_id)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -201,7 +201,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # get_file
+  # Get File
   data, status_code, headers = api_instance.get_file_handler_with_http_info(tr_dataset, file_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -236,9 +236,9 @@ end
 
 > <UploadFileResult> upload_file_handler(tr_dataset, upload_file_data)
 
-upload_file
+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.
+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
 
@@ -258,7 +258,7 @@ tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the reque
 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
+  # Upload File
   result = api_instance.upload_file_handler(tr_dataset, upload_file_data)
   p result
 rescue TrieveRubyClient::ApiError => e
@@ -274,7 +274,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # upload_file
+  # 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 # => { ... }

data/docs/GetEventsData.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::GetEventsData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_types** | **Array<String>** | The type of events to get. Any combination of file_uploaded, card_uploaded, card_action_failed, or card_updated. Leave undefined to get all events. | [optional] |
+| **page** | **Integer** | The page number to get. Default is 1. | [optional] |
+| **page_size** | **Integer** | The number of items per page. Default is 10. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::GetEventsData.new(
+  event_types: null,
+  page: null,
+  page_size: null
+)
+```
+

data/docs/HealthApi.md

@@ -1,17 +1,19 @@
 # TrieveRubyClient::HealthApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**health_check**](HealthApi.md#health_check) | **GET** /api/health |  |
+| [**health_check**](HealthApi.md#health_check) | **GET** /api/health | Health Check |
 
 
 ## health_check
 
 > health_check
 
+Health Check
 
+Health Check  Confirmation that the service is healthy and can make embedding vectors
 
 ### Examples
 
@@ -22,7 +24,7 @@ require 'trieve_ruby_client'
 api_instance = TrieveRubyClient::HealthApi.new
 
 begin
-  
+  # Health Check
   api_instance.health_check
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling HealthApi->health_check: #{e}"
@@ -37,7 +39,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  
+  # Health Check
   data, status_code, headers = api_instance.health_check_with_http_info
   p status_code # => 2xx
   p headers # => { ... }

data/docs/InvitationApi.md

@@ -1,19 +1,19 @@
 # TrieveRubyClient::InvitationApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *http://localhost:8090*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**post_invitation**](InvitationApi.md#post_invitation) | **POST** /api/invitation | send_invitation |
+| [**post_invitation**](InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation |
 
 
 ## post_invitation
 
 > post_invitation(tr_organization, invitation_data)
 
-send_invitation
+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.
+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
 
@@ -33,7 +33,7 @@ tr_organization = 'tr_organization_example' # String | The organization id to us
 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
+  # Send Invitation
   api_instance.post_invitation(tr_organization, invitation_data)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling InvitationApi->post_invitation: #{e}"
@@ -48,7 +48,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
 
 ```ruby
 begin
-  # send_invitation
+  # Send Invitation
   data, status_code, headers = api_instance.post_invitation_with_http_info(tr_organization, invitation_data)
   p status_code # => 2xx
   p headers # => { ... }