trieve_ruby_client 0.3.5 → 0.5.0

data/spec/api/auth_api_spec.rb

@@ -1,10 +1,10 @@
 =begin
-#trieve-server
+#Trieve API
 
-#Trieve REST API OpenAPI Documentation
-
-The version of the OpenAPI document: 0.3.3
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
+The version of the OpenAPI document: 0.5.0
+Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for OpenapiClient::AuthApi
+# Unit tests for TrieveRubyClient::AuthApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'AuthApi' do
   before do
     # run before each test
-    @api_instance = OpenapiClient::AuthApi.new
+    @api_instance = TrieveRubyClient::AuthApi.new
   end
 
   after do
@@ -28,13 +28,13 @@ describe 'AuthApi' do
 
   describe 'test an instance of AuthApi' do
     it 'should create an instance of AuthApi' do
-      expect(@api_instance).to be_instance_of(OpenapiClient::AuthApi)
+      expect(@api_instance).to be_instance_of(TrieveRubyClient::AuthApi)
     end
   end
 
   # unit tests for callback
-  # openid_callback
-  # openid_callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
+  # OpenID Connect callback
+  # OpenID Connect callback  This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
   # @param [Hash] opts the optional parameters
   # @return [SlimUser]
   describe 'callback test' do
@@ -44,8 +44,8 @@ describe 'AuthApi' do
   end
 
   # unit tests for get_me
-  # get_me
-  # get_me  Get the user corresponding to your current auth credentials.
+  # Get Me
+  # Get Me  Get the user corresponding to your current auth credentials.
   # @param [Hash] opts the optional parameters
   # @return [SlimUser]
   describe 'get_me test' do
@@ -55,12 +55,10 @@ describe 'AuthApi' do
   end
 
   # unit tests for login
-  # login
-  # login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+  # Login
+  # Login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
+  # @param content Query parameters for login to be included as kv pairs after ? on the request URL.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
-  # @option opts [String] :organization_id ID of organization to authenticate into
-  # @option opts [String] :redirect_uri URL to redirect to after successful login
   # @return [nil]
   describe 'login test' do
     it 'should work' do
@@ -69,8 +67,8 @@ describe 'AuthApi' do
   end
 
   # unit tests for logout
-  # logout
-  # logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
+  # Logout
+  # Logout  Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'logout test' do

data/spec/api/chunk_api_spec.rb

@@ -1,10 +1,10 @@
 =begin
-#trieve-server
+#Trieve API
 
-#Trieve REST API OpenAPI Documentation
-
-The version of the OpenAPI document: 0.3.3
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
+The version of the OpenAPI document: 0.5.0
+Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for OpenapiClient::ChunkApi
+# Unit tests for TrieveRubyClient::ChunkApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'ChunkApi' do
   before do
     # run before each test
-    @api_instance = OpenapiClient::ChunkApi.new
+    @api_instance = TrieveRubyClient::ChunkApi.new
   end
 
   after do
@@ -28,26 +28,13 @@ describe 'ChunkApi' do
 
   describe 'test an instance of ChunkApi' do
     it 'should create an instance of ChunkApi' do
-      expect(@api_instance).to be_instance_of(OpenapiClient::ChunkApi)
-    end
-  end
-
-  # unit tests for bulk_create_chunk
-  # bulk_create_chunk
-  # bulk_create_chunk  Create a new chunk from an array of chunks. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
-  # @param tr_dataset The dataset id to use for the request
-  # @param create_chunk_data JSON request payload to create a new chunk (chunk)
-  # @param [Hash] opts the optional parameters
-  # @return [ReturnQueuedChunk]
-  describe 'bulk_create_chunk test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      expect(@api_instance).to be_instance_of(TrieveRubyClient::ChunkApi)
     end
   end
 
   # unit tests for create_chunk
-  # create_chunk
-  # create_chunk  Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
+  # Create or Upsert Chunk or Chunks
+  # Create or Upsert Chunk or Chunks  Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
   # @param tr_dataset The dataset id to use for the request
   # @param create_chunk_data JSON request payload to create a new chunk (chunk)
   # @param [Hash] opts the optional parameters
@@ -59,8 +46,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for create_suggested_queries_handler
-  # get_suggested_queries
-  # get_suggested_queries  This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
+  # Generate suggested queries
+  # Generate suggested queries  This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
   # @param tr_dataset The dataset id to use for the request
   # @param suggested_queries_request JSON request payload to get alternative suggested queries
   # @param [Hash] opts the optional parameters
@@ -72,10 +59,10 @@ describe 'ChunkApi' do
   end
 
   # unit tests for delete_chunk
-  # delete_chunk
-  # delete_chunk  Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
+  # Delete Chunk
+  # Delete Chunk  Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
   # @param tr_dataset The dataset id to use for the request
-  # @param chunk_id id of the chunk you want to delete
+  # @param chunk_id Id of the chunk you want to fetch.
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_chunk test' do
@@ -85,8 +72,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for delete_chunk_by_tracking_id
-  # delete_chunk_by_tracking_id
-  # delete_chunk_by_tracking_id  Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
+  # Delete Chunk By Tracking Id
+  # Delete Chunk By Tracking Id  Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
   # @param tr_dataset The dataset id to use for the request
   # @param tracking_id tracking_id of the chunk you want to delete
   # @param [Hash] opts the optional parameters
@@ -98,8 +85,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for generate_off_chunks
-  # augmented_generation_from_chunks
-  # augmented_generation_from_chunks  This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
+  # RAG on Specified Chunks
+  # RAG on Specified Chunks  This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
   # @param tr_dataset The dataset id to use for the request
   # @param generate_chunks_request JSON request payload to perform RAG on some chunks (chunks)
   # @param [Hash] opts the optional parameters
@@ -111,8 +98,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for get_chunk_by_id
-  # get_chunk
-  # get_chunk  Get a singular chunk by id.
+  # Get Chunk By Id
+  # Get Chunk By Id  Get a singular chunk by id.
   # @param tr_dataset The dataset id to use for the request
   # @param chunk_id Id of the chunk you want to fetch.
   # @param [Hash] opts the optional parameters
@@ -124,8 +111,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for get_chunk_by_tracking_id
-  # get_chunk_by_tracking_id
-  # get_chunk_by_tracking_id  Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
+  # Get Chunk By Tracking Id
+  # Get Chunk By Tracking Id  Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
   # @param tr_dataset The dataset id to use for the request
   # @param tracking_id tracking_id of the chunk you want to fetch
   # @param [Hash] opts the optional parameters
@@ -137,8 +124,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for get_recommended_chunks
-  # get_recommended_chunks
-  # get_recommended_chunks  Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
+  # Get Recommended Chunks
+  # Get Recommended Chunks  Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
   # @param tr_dataset The dataset id to use for the request
   # @param recommend_chunks_request JSON request payload to get recommendations of chunks similar to the chunks in the request
   # @param [Hash] opts the optional parameters
@@ -150,8 +137,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for search_chunk
-  # search
-  # search  This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
+  # Search
+  # Search  This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b>` tags for sub-sentence highlighting.
   # @param tr_dataset The dataset id to use for the request
   # @param search_chunk_data JSON request payload to semantically search for chunks (chunks)
   # @param [Hash] opts the optional parameters
@@ -163,8 +150,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for update_chunk
-  # update_chunk
-  # update_chunk  Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
+  # Update Chunk
+  # Update Chunk  Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
   # @param tr_dataset The dataset id to use for the request
   # @param update_chunk_data JSON request payload to update a chunk (chunk)
   # @param [Hash] opts the optional parameters
@@ -176,8 +163,8 @@ describe 'ChunkApi' do
   end
 
   # unit tests for update_chunk_by_tracking_id
-  # update_chunk_by_tracking_id
-  # update_chunk_by_tracking_id  Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
+  # Update Chunk By Tracking Id
+  # Update Chunk By Tracking Id  Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
   # @param tr_dataset The dataset id to use for the request
   # @param update_chunk_by_tracking_id_data JSON request payload to update a chunk by tracking_id (chunks)
   # @param [Hash] opts the optional parameters

data/spec/api/chunk_group_api_spec.rb

@@ -1,10 +1,10 @@
 =begin
-#trieve-server
+#Trieve API
 
-#Trieve REST API OpenAPI Documentation
-
-The version of the OpenAPI document: 0.3.3
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
+The version of the OpenAPI document: 0.5.0
+Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for OpenapiClient::ChunkGroupApi
+# Unit tests for TrieveRubyClient::ChunkGroupApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'ChunkGroupApi' do
   before do
     # run before each test
-    @api_instance = OpenapiClient::ChunkGroupApi.new
+    @api_instance = TrieveRubyClient::ChunkGroupApi.new
   end
 
   after do
@@ -28,13 +28,13 @@ describe 'ChunkGroupApi' do
 
   describe 'test an instance of ChunkGroupApi' do
     it 'should create an instance of ChunkGroupApi' do
-      expect(@api_instance).to be_instance_of(OpenapiClient::ChunkGroupApi)
+      expect(@api_instance).to be_instance_of(TrieveRubyClient::ChunkGroupApi)
     end
   end
 
   # unit tests for add_chunk_to_group
-  # add_chunk_to_group
-  # add_chunk_to_group  Route to add a chunk to a group
+  # Add Chunk to Group
+  # Add Chunk to Group  Route to add a chunk to a group.
   # @param tr_dataset The dataset id to use for the request
   # @param group_id Id of the group to add the chunk to as a bookmark
   # @param add_chunk_to_group_data JSON request payload to add a chunk to a group (bookmark it)
@@ -47,8 +47,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for add_chunk_to_group_by_tracking_id
-  # add_chunk_to_group_by_tracking_id
-  # add_chunk_to_group_by_tracking_id  Route to add a chunk to a group by tracking id. Think of a bookmark as a chunk which is a member of a group.
+  # Add Chunk to Group by Tracking ID
+  # Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id.
   # @param tr_dataset The dataset id to use for the request
   # @param tracking_id Id of the group to add the chunk to as a bookmark
   # @param add_chunk_to_group_data JSON request payload to add a chunk to a group (bookmark it)
@@ -61,8 +61,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for create_chunk_group
-  # create_chunk_group
-  # create_chunk_group  Create a new chunk_group.
+  # Create Chunk Group
+  # Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
   # @param tr_dataset The dataset id to use for the request
   # @param create_chunk_group_data JSON request payload to cretea a chunkGroup
   # @param [Hash] opts the optional parameters
@@ -74,10 +74,10 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for delete_chunk_group
-  # delete_chunk_group
-  # delete_chunk_group  This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
+  # Delete Group
+  # Delete Group  This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
   # @param tr_dataset The dataset id to use for the request
-  # @param group_id Id of the chunk_group to delete
+  # @param group_id Id of the group you want to fetch.
   # @param delete_chunks Delete the chunks within the group
   # @param [Hash] opts the optional parameters
   # @return [nil]
@@ -88,6 +88,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for delete_group_by_tracking_id
+  # Delete Group by Tracking ID
+  # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id.
   # @param tr_dataset The dataset id to use for the request
   # @param tracking_id Tracking id of the chunk_group to delete
   # @param [Hash] opts the optional parameters
@@ -98,11 +100,24 @@ describe 'ChunkGroupApi' do
     end
   end
 
+  # unit tests for get_chunk_group
+  # Get Group
+  # Get Group  Fetch the group with the given id. get_group
+  # @param tr_dataset The dataset id to use for the request
+  # @param group_id Id of the group you want to fetch.
+  # @param [Hash] opts the optional parameters
+  # @return [ChunkGroup]
+  describe 'get_chunk_group test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_chunks_in_group
-  # get_chunks_in_group
-  # get_chunks_in_group  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
+  # Get Chunks in Group
+  # Get Chunks in Group  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
   # @param tr_dataset The dataset id to use for the request
-  # @param group_id The id of the group to get the chunks from
+  # @param group_id Id of the group you want to fetch.
   # @param page The page of chunks to get from the group
   # @param [Hash] opts the optional parameters
   # @return [BookmarkData]
@@ -113,8 +128,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for get_chunks_in_group_by_tracking_id
-  # get_chunks_in_group_by_tracking_id
-  # get_chunks_in_group_by_tracking_id  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
+  # Get Chunks in Group by Tracking ID
+  # Get Chunks in Group by Tracking ID  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
   # @param tr_dataset The dataset id to use for the request
   # @param group_tracking_id The id of the group to get the chunks from
   # @param page The page of chunks to get from the group
@@ -127,8 +142,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for get_group_by_tracking_id
-  # get_group_by_tracking_id
-  # get_group_by_tracking_id
+  # Get Group by Tracking ID
+  # Get Group by Tracking ID  Fetch the group with the given tracking id. get_group_by_tracking_id
   # @param tr_dataset The dataset id to use for the request
   # @param tracking_id The tracking id of the group to fetch.
   # @param [Hash] opts the optional parameters
@@ -140,6 +155,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for get_groups_chunk_is_in
+  # Get Groups for Chunks
+  # Get Groups for Chunks  Route to get the groups that a chunk is in.
   # @param tr_dataset The dataset id to use for the request
   # @param get_groups_for_chunks_data JSON request payload to get the groups that a chunk is in
   # @param [Hash] opts the optional parameters
@@ -151,6 +168,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for get_recommended_groups
+  # Get Recommended Groups
+  # Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
   # @param tr_dataset The dataset id to use for the request
   # @param reccomend_group_chunks_request JSON request payload to get recommendations of chunks similar to the chunks in the request
   # @param [Hash] opts the optional parameters
@@ -162,8 +181,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for get_specific_dataset_chunk_groups
-  # get_dataset_groups
-  # get_dataset_groups  Fetch the groups which belong to a dataset specified by its id.
+  # Get Groups for Dataset
+  # Get Groups for Dataset  Fetch the groups which belong to a dataset specified by its id.
   # @param tr_dataset The dataset id to use for the request
   # @param dataset_id The id of the dataset to fetch groups for.
   # @param page The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
@@ -176,8 +195,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for remove_chunk_from_group
-  # remove_chunk_from_group
-  # remove_chunk_from_group  Route to remove a chunk from a group.
+  # Remove Chunk from Group
+  # Remove Chunk from Group  Route to remove a chunk from a group.
   # @param tr_dataset The dataset id to use for the request
   # @param group_id Id of the group to remove the bookmark'ed chunk from
   # @param create_chunk_group_data JSON request payload to cretea a chunkGroup
@@ -190,8 +209,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for search_over_groups
-  # group_oriented_search
-  # group_oriented_search  This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
+  # Search Over Groups
+  # Search Over Groups  This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
   # @param search_over_groups_data JSON request payload to semantically search over groups
   # @param [Hash] opts the optional parameters
   # @return [SearchOverGroupsResponseBody]
@@ -202,8 +221,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for search_within_group
-  # search_within_group
-  # search_within_group  This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
+  # Search Within Group
+  # Search Within Group  This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
   # @param tr_dataset The dataset id to use for the request
   # @param search_within_group_data JSON request payload to semantically search a group
   # @param [Hash] opts the optional parameters
@@ -215,8 +234,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for update_chunk_group
-  # update_chunk_group
-  # update_chunk_group  Update a chunk_group.
+  # Update Group
+  # Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
   # @param tr_dataset The dataset id to use for the request
   # @param update_chunk_group_data JSON request payload to update a chunkGroup
   # @param [Hash] opts the optional parameters
@@ -228,6 +247,8 @@ describe 'ChunkGroupApi' do
   end
 
   # unit tests for update_group_by_tracking_id
+  # Update Group by Tracking ID
+  # Update Group by Tracking ID  Update a chunk_group with the given tracking id.
   # @param tr_dataset The dataset id to use for the request
   # @param tracking_id Tracking id of the chunk_group to update
   # @param update_group_by_tracking_id_data JSON request payload to update a chunkGroup

data/spec/api/dataset_api_spec.rb

@@ -1,10 +1,10 @@
 =begin
-#trieve-server
+#Trieve API
 
-#Trieve REST API OpenAPI Documentation
-
-The version of the OpenAPI document: 0.3.3
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
+The version of the OpenAPI document: 0.5.0
+Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for OpenapiClient::DatasetApi
+# Unit tests for TrieveRubyClient::DatasetApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'DatasetApi' do
   before do
     # run before each test
-    @api_instance = OpenapiClient::DatasetApi.new
+    @api_instance = TrieveRubyClient::DatasetApi.new
   end
 
   after do
@@ -28,13 +28,13 @@ describe 'DatasetApi' do
 
   describe 'test an instance of DatasetApi' do
     it 'should create an instance of DatasetApi' do
-      expect(@api_instance).to be_instance_of(OpenapiClient::DatasetApi)
+      expect(@api_instance).to be_instance_of(TrieveRubyClient::DatasetApi)
     end
   end
 
   # unit tests for 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 dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
   # @param tr_organization The organization id to use for the request
   # @param create_dataset_request JSON request payload to create a new dataset
   # @param [Hash] opts the optional parameters
@@ -46,8 +46,8 @@ describe 'DatasetApi' do
   end
 
   # unit tests for 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 Dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
   # @param tr_organization The organization id to use for the request
   # @param delete_dataset_request JSON request payload to delete a dataset
   # @param [Hash] opts the optional parameters
@@ -59,8 +59,8 @@ describe 'DatasetApi' do
   end
 
   # unit tests for get_client_dataset_config
-  # get_client_dataset_config
-  # get_client_dataset_config  Get the client configuration for a dataset. Will use the TR-D
+  # Get Client Configuration
+  # Get Client Configuration  Get the client configuration for a dataset. Will use the TR-D
   # @param tr_dataset The dataset id to use for the request
   # @param [Hash] opts the optional parameters
   # @return [ClientDatasetConfiguration]
@@ -71,8 +71,8 @@ describe 'DatasetApi' do
   end
 
   # unit tests for 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 Dataset  Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
   # @param tr_organization The organization id to use for the request
   # @param tr_dataset The dataset id to use for the request
   # @param dataset_id The id of the dataset you want to retrieve.
@@ -85,8 +85,8 @@ describe 'DatasetApi' do
   end
 
   # unit tests for get_datasets_from_organization
-  # get_organization_datasets
-  # 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 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.
   # @param tr_organization The organization id to use for the request
   # @param organization_id id of the organization you want to retrieve datasets for
   # @param [Hash] opts the optional parameters
@@ -98,8 +98,8 @@ describe 'DatasetApi' do
   end
 
   # unit tests for 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 Dataset  Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
   # @param tr_organization The organization id to use for the request
   # @param update_dataset_request JSON request payload to update a dataset
   # @param [Hash] opts the optional parameters

data/spec/api/events_api_spec.rb

@@ -1,10 +1,10 @@
 =begin
-#trieve-server
+#Trieve API
 
-#Trieve REST API OpenAPI Documentation
-
-The version of the OpenAPI document: 0.3.3
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
+The version of the OpenAPI document: 0.5.0
+Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
 
@@ -13,13 +13,13 @@ Generator version: 7.4.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for OpenapiClient::EventsApi
+# Unit tests for TrieveRubyClient::EventsApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'EventsApi' do
   before do
     # run before each test
-    @api_instance = OpenapiClient::EventsApi.new
+    @api_instance = TrieveRubyClient::EventsApi.new
   end
 
   after do
@@ -28,15 +28,15 @@ describe 'EventsApi' do
 
   describe 'test an instance of EventsApi' do
     it 'should create an instance of EventsApi' do
-      expect(@api_instance).to be_instance_of(OpenapiClient::EventsApi)
+      expect(@api_instance).to be_instance_of(TrieveRubyClient::EventsApi)
     end
   end
 
   # unit tests for get_events
-  # 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.
+  # Get events for the dataset
+  # 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.
   # @param tr_dataset The dataset id to use for the request
-  # @param page Page number of events to get
+  # @param get_events_data JSON request payload to get events for a dataset
   # @param [Hash] opts the optional parameters
   # @return [EventReturn]
   describe 'get_events test' do