trieve_ruby_client 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +240 -0
- data/Rakefile +10 -0
- data/docs/AddChunkToGroupData.md +18 -0
- data/docs/ApiKeyDTO.md +28 -0
- data/docs/AuthApi.md +274 -0
- data/docs/BookmarkData.md +22 -0
- data/docs/BookmarkGroupResult.md +20 -0
- data/docs/ChatMessageProxy.md +20 -0
- data/docs/ChunkApi.md +955 -0
- data/docs/ChunkFilter.md +22 -0
- data/docs/ChunkGroup.md +30 -0
- data/docs/ChunkGroupAndFile.md +32 -0
- data/docs/ChunkGroupApi.md +1262 -0
- data/docs/ChunkMetadata.md +42 -0
- data/docs/ChunkMetadataWithFileData.md +44 -0
- data/docs/ClientDatasetConfiguration.md +38 -0
- data/docs/CreateChunkData.md +42 -0
- data/docs/CreateChunkGroupData.md +22 -0
- data/docs/CreateDatasetRequest.md +24 -0
- data/docs/CreateMessageData.md +28 -0
- data/docs/CreateOrganizationData.md +18 -0
- data/docs/CreateTopicData.md +22 -0
- data/docs/Dataset.md +30 -0
- data/docs/DatasetAndUsage.md +20 -0
- data/docs/DatasetApi.md +480 -0
- data/docs/DatasetDTO.md +28 -0
- data/docs/DatasetUsageCount.md +22 -0
- data/docs/DeleteDatasetRequest.md +18 -0
- data/docs/DeleteTopicData.md +18 -0
- data/docs/DeleteUserApiKeyRequest.md +18 -0
- data/docs/EditMessageData.md +30 -0
- data/docs/ErrorResponseBody.md +18 -0
- data/docs/Event.md +28 -0
- data/docs/EventReturn.md +20 -0
- data/docs/EventsApi.md +86 -0
- data/docs/FieldCondition.md +22 -0
- data/docs/File.md +36 -0
- data/docs/FileApi.md +326 -0
- data/docs/FileDTO.md +32 -0
- data/docs/GenerateChunksRequest.md +26 -0
- data/docs/GetGroupsForChunksData.md +18 -0
- data/docs/GroupData.md +20 -0
- data/docs/GroupScoreChunkDTO.md +20 -0
- data/docs/HealthApi.md +66 -0
- data/docs/InvitationApi.md +85 -0
- data/docs/InvitationData.md +26 -0
- data/docs/MatchCondition.md +49 -0
- data/docs/Message.md +38 -0
- data/docs/MessageApi.md +322 -0
- data/docs/Organization.md +26 -0
- data/docs/OrganizationApi.md +479 -0
- data/docs/OrganizationUsageCount.md +28 -0
- data/docs/Range.md +24 -0
- data/docs/ReccomendGroupChunksRequest.md +30 -0
- data/docs/RecommendChunksRequest.md +28 -0
- data/docs/RegenerateMessageData.md +26 -0
- data/docs/ReturnQueuedChunk.md +20 -0
- data/docs/ScoreChunkDTO.md +20 -0
- data/docs/SearchChunkData.md +38 -0
- data/docs/SearchChunkQueryResponseBody.md +20 -0
- data/docs/SearchGroupsResult.md +22 -0
- data/docs/SearchOverGroupsData.md +36 -0
- data/docs/SearchOverGroupsResponseBody.md +20 -0
- data/docs/SearchWithinGroupData.md +40 -0
- data/docs/SetUserApiKeyRequest.md +20 -0
- data/docs/SetUserApiKeyResponse.md +18 -0
- data/docs/SlimGroup.md +24 -0
- data/docs/SlimUser.md +32 -0
- data/docs/StripeApi.md +285 -0
- data/docs/StripePlan.md +38 -0
- data/docs/StripeSubscription.md +30 -0
- data/docs/SuggestedQueriesRequest.md +18 -0
- data/docs/SuggestedQueriesResponse.md +18 -0
- data/docs/Topic.md +30 -0
- data/docs/TopicApi.md +321 -0
- data/docs/UpdateChunkByTrackingIdData.md +32 -0
- data/docs/UpdateChunkData.md +34 -0
- data/docs/UpdateChunkGroupData.md +24 -0
- data/docs/UpdateDatasetRequest.md +24 -0
- data/docs/UpdateGroupByTrackingIDData.md +22 -0
- data/docs/UpdateOrganizationData.md +20 -0
- data/docs/UpdateTopicData.md +20 -0
- data/docs/UpdateUserData.md +30 -0
- data/docs/UploadFileData.md +34 -0
- data/docs/UploadFileResult.md +18 -0
- data/docs/UserApi.md +238 -0
- data/docs/UserOrganization.md +28 -0
- data/git_push.sh +57 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +262 -0
- data/lib/trieve_ruby_client/api/chunk_api.rb +906 -0
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +1230 -0
- data/lib/trieve_ruby_client/api/dataset_api.rb +458 -0
- data/lib/trieve_ruby_client/api/events_api.rb +92 -0
- data/lib/trieve_ruby_client/api/file_api.rb +324 -0
- data/lib/trieve_ruby_client/api/health_api.rb +75 -0
- data/lib/trieve_ruby_client/api/invitation_api.rb +97 -0
- data/lib/trieve_ruby_client/api/message_api.rb +317 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +445 -0
- data/lib/trieve_ruby_client/api/stripe_api.rb +278 -0
- data/lib/trieve_ruby_client/api/topic_api.rb +317 -0
- data/lib/trieve_ruby_client/api/user_api.rb +226 -0
- data/lib/trieve_ruby_client/api_client.rb +394 -0
- data/lib/trieve_ruby_client/api_error.rb +58 -0
- data/lib/trieve_ruby_client/configuration.rb +305 -0
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +222 -0
- data/lib/trieve_ruby_client/models/api_key_dto.rb +301 -0
- data/lib/trieve_ruby_client/models/bookmark_data.rb +255 -0
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +239 -0
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +237 -0
- data/lib/trieve_ruby_client/models/chunk_filter.rb +244 -0
- data/lib/trieve_ruby_client/models/chunk_group.rb +311 -0
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +321 -0
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +371 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_with_file_data.rb +381 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +336 -0
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +356 -0
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +250 -0
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +265 -0
- data/lib/trieve_ruby_client/models/create_message_data.rb +285 -0
- data/lib/trieve_ruby_client/models/create_organization_data.rb +222 -0
- data/lib/trieve_ruby_client/models/create_topic_data.rb +238 -0
- data/lib/trieve_ruby_client/models/dataset.rb +309 -0
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +237 -0
- data/lib/trieve_ruby_client/models/dataset_dto.rb +297 -0
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +253 -0
- data/lib/trieve_ruby_client/models/delete_dataset_request.rb +222 -0
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +222 -0
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +222 -0
- data/lib/trieve_ruby_client/models/edit_message_data.rb +302 -0
- data/lib/trieve_ruby_client/models/error_response_body.rb +221 -0
- data/lib/trieve_ruby_client/models/event.rb +297 -0
- data/lib/trieve_ruby_client/models/event_return.rb +239 -0
- data/lib/trieve_ruby_client/models/field_condition.rb +245 -0
- data/lib/trieve_ruby_client/models/file.rb +341 -0
- data/lib/trieve_ruby_client/models/file_dto.rb +321 -0
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +276 -0
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +223 -0
- data/lib/trieve_ruby_client/models/group_data.rb +239 -0
- data/lib/trieve_ruby_client/models/group_score_chunk_dto.rb +239 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +290 -0
- data/lib/trieve_ruby_client/models/match_condition.rb +105 -0
- data/lib/trieve_ruby_client/models/message.rb +369 -0
- data/lib/trieve_ruby_client/models/organization.rb +279 -0
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +301 -0
- data/lib/trieve_ruby_client/models/range.rb +245 -0
- data/lib/trieve_ruby_client/models/reccomend_group_chunks_request.rb +319 -0
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +293 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +268 -0
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +237 -0
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +239 -0
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +369 -0
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_groups_result.rb +255 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +372 -0
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +380 -0
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +239 -0
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +222 -0
- data/lib/trieve_ruby_client/models/slim_group.rb +269 -0
- data/lib/trieve_ruby_client/models/slim_user.rb +319 -0
- data/lib/trieve_ruby_client/models/stripe_plan.rb +381 -0
- data/lib/trieve_ruby_client/models/stripe_subscription.rb +311 -0
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +222 -0
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +223 -0
- data/lib/trieve_ruby_client/models/topic.rb +317 -0
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +303 -0
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +308 -0
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +249 -0
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +255 -0
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +244 -0
- data/lib/trieve_ruby_client/models/update_organization_data.rb +233 -0
- data/lib/trieve_ruby_client/models/update_topic_data.rb +239 -0
- data/lib/trieve_ruby_client/models/update_user_data.rb +288 -0
- data/lib/trieve_ruby_client/models/upload_file_data.rb +324 -0
- data/lib/trieve_ruby_client/models/upload_file_result.rb +221 -0
- data/lib/trieve_ruby_client/models/user_organization.rb +301 -0
- data/lib/trieve_ruby_client/version.rb +15 -0
- data/lib/trieve_ruby_client.rb +124 -0
- data/openapi-generator.yaml +9 -0
- data/openapi.json +6530 -0
- data/openapitools.json +7 -0
- data/spec/api/auth_api_spec.rb +82 -0
- data/spec/api/chunk_api_spec.rb +191 -0
- data/spec/api/chunk_group_api_spec.rb +242 -0
- data/spec/api/dataset_api_spec.rb +113 -0
- data/spec/api/events_api_spec.rb +48 -0
- data/spec/api/file_api_spec.rb +89 -0
- data/spec/api/health_api_spec.rb +44 -0
- data/spec/api/invitation_api_spec.rb +48 -0
- data/spec/api/message_api_spec.rb +87 -0
- data/spec/api/organization_api_spec.rb +112 -0
- data/spec/api/stripe_api_spec.rb +78 -0
- data/spec/api/topic_api_spec.rb +87 -0
- data/spec/api/user_api_spec.rb +71 -0
- data/spec/models/add_chunk_to_group_data_spec.rb +36 -0
- data/spec/models/api_key_dto_spec.rb +66 -0
- data/spec/models/bookmark_data_spec.rb +48 -0
- data/spec/models/bookmark_group_result_spec.rb +42 -0
- data/spec/models/chat_message_proxy_spec.rb +42 -0
- data/spec/models/chunk_filter_spec.rb +48 -0
- data/spec/models/chunk_group_and_file_spec.rb +78 -0
- data/spec/models/chunk_group_spec.rb +72 -0
- data/spec/models/chunk_metadata_spec.rb +108 -0
- data/spec/models/chunk_metadata_with_file_data_spec.rb +114 -0
- data/spec/models/client_dataset_configuration_spec.rb +96 -0
- data/spec/models/create_chunk_data_spec.rb +108 -0
- data/spec/models/create_chunk_group_data_spec.rb +48 -0
- data/spec/models/create_dataset_request_spec.rb +54 -0
- data/spec/models/create_message_data_spec.rb +66 -0
- data/spec/models/create_organization_data_spec.rb +36 -0
- data/spec/models/create_topic_data_spec.rb +48 -0
- data/spec/models/dataset_and_usage_spec.rb +42 -0
- data/spec/models/dataset_dto_spec.rb +66 -0
- data/spec/models/dataset_spec.rb +72 -0
- data/spec/models/dataset_usage_count_spec.rb +48 -0
- data/spec/models/delete_dataset_request_spec.rb +36 -0
- data/spec/models/delete_topic_data_spec.rb +36 -0
- data/spec/models/delete_user_api_key_request_spec.rb +36 -0
- data/spec/models/edit_message_data_spec.rb +72 -0
- data/spec/models/error_response_body_spec.rb +36 -0
- data/spec/models/event_return_spec.rb +42 -0
- data/spec/models/event_spec.rb +66 -0
- data/spec/models/field_condition_spec.rb +48 -0
- data/spec/models/file_dto_spec.rb +78 -0
- data/spec/models/file_spec.rb +90 -0
- data/spec/models/generate_chunks_request_spec.rb +60 -0
- data/spec/models/get_groups_for_chunks_data_spec.rb +36 -0
- data/spec/models/group_data_spec.rb +42 -0
- data/spec/models/group_score_chunk_dto_spec.rb +42 -0
- data/spec/models/invitation_data_spec.rb +60 -0
- data/spec/models/match_condition_spec.rb +32 -0
- data/spec/models/message_spec.rb +96 -0
- data/spec/models/organization_spec.rb +60 -0
- data/spec/models/organization_usage_count_spec.rb +66 -0
- data/spec/models/range_spec.rb +54 -0
- data/spec/models/reccomend_group_chunks_request_spec.rb +72 -0
- data/spec/models/recommend_chunks_request_spec.rb +66 -0
- data/spec/models/regenerate_message_data_spec.rb +60 -0
- data/spec/models/return_queued_chunk_spec.rb +42 -0
- data/spec/models/score_chunk_dto_spec.rb +42 -0
- data/spec/models/search_chunk_data_spec.rb +96 -0
- data/spec/models/search_chunk_query_response_body_spec.rb +42 -0
- data/spec/models/search_groups_result_spec.rb +48 -0
- data/spec/models/search_over_groups_data_spec.rb +90 -0
- data/spec/models/search_over_groups_response_body_spec.rb +42 -0
- data/spec/models/search_within_group_data_spec.rb +102 -0
- data/spec/models/set_user_api_key_request_spec.rb +42 -0
- data/spec/models/set_user_api_key_response_spec.rb +36 -0
- data/spec/models/slim_group_spec.rb +54 -0
- data/spec/models/slim_user_spec.rb +78 -0
- data/spec/models/stripe_plan_spec.rb +96 -0
- data/spec/models/stripe_subscription_spec.rb +72 -0
- data/spec/models/suggested_queries_request_spec.rb +36 -0
- data/spec/models/suggested_queries_response_spec.rb +36 -0
- data/spec/models/topic_spec.rb +72 -0
- data/spec/models/update_chunk_by_tracking_id_data_spec.rb +66 -0
- data/spec/models/update_chunk_data_spec.rb +72 -0
- data/spec/models/update_chunk_group_data_spec.rb +48 -0
- data/spec/models/update_dataset_request_spec.rb +54 -0
- data/spec/models/update_group_by_tracking_id_data_spec.rb +48 -0
- data/spec/models/update_organization_data_spec.rb +42 -0
- data/spec/models/update_topic_data_spec.rb +42 -0
- data/spec/models/update_user_data_spec.rb +72 -0
- data/spec/models/upload_file_data_spec.rb +84 -0
- data/spec/models/upload_file_result_spec.rb +36 -0
- data/spec/models/user_organization_spec.rb +66 -0
- data/spec/spec_helper.rb +111 -0
- data/trieve_ruby_client.gemspec +39 -0
- metadata +439 -0
data/openapitools.json
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
=begin
|
2
|
+
#trieve-server
|
3
|
+
|
4
|
+
#Trieve REST API OpenAPI Documentation
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.3.3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::AuthApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'AuthApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::AuthApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of AuthApi' do
|
30
|
+
it 'should create an instance of AuthApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::AuthApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for callback
|
36
|
+
# openid_callback
|
37
|
+
# openid_callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [SlimUser]
|
40
|
+
describe 'callback test' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
# unit tests for get_me
|
47
|
+
# get_me
|
48
|
+
# get_me Get the user corresponding to your current auth credentials.
|
49
|
+
# @param [Hash] opts the optional parameters
|
50
|
+
# @return [SlimUser]
|
51
|
+
describe 'get_me test' do
|
52
|
+
it 'should work' do
|
53
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# unit tests for login
|
58
|
+
# login
|
59
|
+
# login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
|
60
|
+
# @param [Hash] opts the optional parameters
|
61
|
+
# @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
|
62
|
+
# @option opts [String] :organization_id ID of organization to authenticate into
|
63
|
+
# @option opts [String] :redirect_uri URL to redirect to after successful login
|
64
|
+
# @return [nil]
|
65
|
+
describe 'login test' do
|
66
|
+
it 'should work' do
|
67
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
# unit tests for logout
|
72
|
+
# logout
|
73
|
+
# logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.
|
74
|
+
# @param [Hash] opts the optional parameters
|
75
|
+
# @return [nil]
|
76
|
+
describe 'logout test' do
|
77
|
+
it 'should work' do
|
78
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
end
|
@@ -0,0 +1,191 @@
|
|
1
|
+
=begin
|
2
|
+
#trieve-server
|
3
|
+
|
4
|
+
#Trieve REST API OpenAPI Documentation
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.3.3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::ChunkApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'ChunkApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::ChunkApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of ChunkApi' do
|
30
|
+
it 'should create an instance of ChunkApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::ChunkApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for bulk_create_chunk
|
36
|
+
# bulk_create_chunk
|
37
|
+
# 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.
|
38
|
+
# @param tr_dataset The dataset id to use for the request
|
39
|
+
# @param create_chunk_data JSON request payload to create a new chunk (chunk)
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [ReturnQueuedChunk]
|
42
|
+
describe 'bulk_create_chunk test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for create_chunk
|
49
|
+
# create_chunk
|
50
|
+
# 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.
|
51
|
+
# @param tr_dataset The dataset id to use for the request
|
52
|
+
# @param create_chunk_data JSON request payload to create a new chunk (chunk)
|
53
|
+
# @param [Hash] opts the optional parameters
|
54
|
+
# @return [ReturnQueuedChunk]
|
55
|
+
describe 'create_chunk test' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# unit tests for create_suggested_queries_handler
|
62
|
+
# get_suggested_queries
|
63
|
+
# 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.
|
64
|
+
# @param tr_dataset The dataset id to use for the request
|
65
|
+
# @param suggested_queries_request JSON request payload to get alternative suggested queries
|
66
|
+
# @param [Hash] opts the optional parameters
|
67
|
+
# @return [SuggestedQueriesResponse]
|
68
|
+
describe 'create_suggested_queries_handler test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# unit tests for delete_chunk
|
75
|
+
# delete_chunk
|
76
|
+
# 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.
|
77
|
+
# @param tr_dataset The dataset id to use for the request
|
78
|
+
# @param chunk_id id of the chunk you want to delete
|
79
|
+
# @param [Hash] opts the optional parameters
|
80
|
+
# @return [nil]
|
81
|
+
describe 'delete_chunk test' do
|
82
|
+
it 'should work' do
|
83
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# unit tests for delete_chunk_by_tracking_id
|
88
|
+
# delete_chunk_by_tracking_id
|
89
|
+
# 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.
|
90
|
+
# @param tr_dataset The dataset id to use for the request
|
91
|
+
# @param tracking_id tracking_id of the chunk you want to delete
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [nil]
|
94
|
+
describe 'delete_chunk_by_tracking_id test' do
|
95
|
+
it 'should work' do
|
96
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
# unit tests for generate_off_chunks
|
101
|
+
# augmented_generation_from_chunks
|
102
|
+
# 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.
|
103
|
+
# @param tr_dataset The dataset id to use for the request
|
104
|
+
# @param generate_chunks_request JSON request payload to perform RAG on some chunks (chunks)
|
105
|
+
# @param [Hash] opts the optional parameters
|
106
|
+
# @return [String]
|
107
|
+
describe 'generate_off_chunks test' do
|
108
|
+
it 'should work' do
|
109
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# unit tests for get_chunk_by_id
|
114
|
+
# get_chunk
|
115
|
+
# get_chunk Get a singular chunk by id.
|
116
|
+
# @param tr_dataset The dataset id to use for the request
|
117
|
+
# @param chunk_id Id of the chunk you want to fetch.
|
118
|
+
# @param [Hash] opts the optional parameters
|
119
|
+
# @return [ChunkMetadata]
|
120
|
+
describe 'get_chunk_by_id test' do
|
121
|
+
it 'should work' do
|
122
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
# unit tests for get_chunk_by_tracking_id
|
127
|
+
# get_chunk_by_tracking_id
|
128
|
+
# 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.
|
129
|
+
# @param tr_dataset The dataset id to use for the request
|
130
|
+
# @param tracking_id tracking_id of the chunk you want to fetch
|
131
|
+
# @param [Hash] opts the optional parameters
|
132
|
+
# @return [ChunkMetadata]
|
133
|
+
describe 'get_chunk_by_tracking_id test' do
|
134
|
+
it 'should work' do
|
135
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
139
|
+
# unit tests for get_recommended_chunks
|
140
|
+
# get_recommended_chunks
|
141
|
+
# 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.
|
142
|
+
# @param tr_dataset The dataset id to use for the request
|
143
|
+
# @param recommend_chunks_request JSON request payload to get recommendations of chunks similar to the chunks in the request
|
144
|
+
# @param [Hash] opts the optional parameters
|
145
|
+
# @return [Array<ChunkMetadataWithFileData>]
|
146
|
+
describe 'get_recommended_chunks test' do
|
147
|
+
it 'should work' do
|
148
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
152
|
+
# unit tests for search_chunk
|
153
|
+
# search
|
154
|
+
# 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.
|
155
|
+
# @param tr_dataset The dataset id to use for the request
|
156
|
+
# @param search_chunk_data JSON request payload to semantically search for chunks (chunks)
|
157
|
+
# @param [Hash] opts the optional parameters
|
158
|
+
# @return [SearchChunkQueryResponseBody]
|
159
|
+
describe 'search_chunk test' do
|
160
|
+
it 'should work' do
|
161
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
162
|
+
end
|
163
|
+
end
|
164
|
+
|
165
|
+
# unit tests for update_chunk
|
166
|
+
# update_chunk
|
167
|
+
# 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.
|
168
|
+
# @param tr_dataset The dataset id to use for the request
|
169
|
+
# @param update_chunk_data JSON request payload to update a chunk (chunk)
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @return [nil]
|
172
|
+
describe 'update_chunk test' do
|
173
|
+
it 'should work' do
|
174
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
178
|
+
# unit tests for update_chunk_by_tracking_id
|
179
|
+
# update_chunk_by_tracking_id
|
180
|
+
# 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.
|
181
|
+
# @param tr_dataset The dataset id to use for the request
|
182
|
+
# @param update_chunk_by_tracking_id_data JSON request payload to update a chunk by tracking_id (chunks)
|
183
|
+
# @param [Hash] opts the optional parameters
|
184
|
+
# @return [nil]
|
185
|
+
describe 'update_chunk_by_tracking_id test' do
|
186
|
+
it 'should work' do
|
187
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
end
|
@@ -0,0 +1,242 @@
|
|
1
|
+
=begin
|
2
|
+
#trieve-server
|
3
|
+
|
4
|
+
#Trieve REST API OpenAPI Documentation
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.3.3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::ChunkGroupApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'ChunkGroupApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::ChunkGroupApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of ChunkGroupApi' do
|
30
|
+
it 'should create an instance of ChunkGroupApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::ChunkGroupApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for add_chunk_to_group
|
36
|
+
# add_chunk_to_group
|
37
|
+
# add_chunk_to_group Route to add a chunk to a group
|
38
|
+
# @param tr_dataset The dataset id to use for the request
|
39
|
+
# @param group_id Id of the group to add the chunk to as a bookmark
|
40
|
+
# @param add_chunk_to_group_data JSON request payload to add a chunk to a group (bookmark it)
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
# @return [nil]
|
43
|
+
describe 'add_chunk_to_group test' do
|
44
|
+
it 'should work' do
|
45
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
# unit tests for add_chunk_to_group_by_tracking_id
|
50
|
+
# add_chunk_to_group_by_tracking_id
|
51
|
+
# 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.
|
52
|
+
# @param tr_dataset The dataset id to use for the request
|
53
|
+
# @param tracking_id Id of the group to add the chunk to as a bookmark
|
54
|
+
# @param add_chunk_to_group_data JSON request payload to add a chunk to a group (bookmark it)
|
55
|
+
# @param [Hash] opts the optional parameters
|
56
|
+
# @return [nil]
|
57
|
+
describe 'add_chunk_to_group_by_tracking_id test' do
|
58
|
+
it 'should work' do
|
59
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# unit tests for create_chunk_group
|
64
|
+
# create_chunk_group
|
65
|
+
# create_chunk_group Create a new chunk_group.
|
66
|
+
# @param tr_dataset The dataset id to use for the request
|
67
|
+
# @param create_chunk_group_data JSON request payload to cretea a chunkGroup
|
68
|
+
# @param [Hash] opts the optional parameters
|
69
|
+
# @return [ChunkGroup]
|
70
|
+
describe 'create_chunk_group test' do
|
71
|
+
it 'should work' do
|
72
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
# unit tests for delete_chunk_group
|
77
|
+
# delete_chunk_group
|
78
|
+
# 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.
|
79
|
+
# @param tr_dataset The dataset id to use for the request
|
80
|
+
# @param group_id Id of the chunk_group to delete
|
81
|
+
# @param delete_chunks Delete the chunks within the group
|
82
|
+
# @param [Hash] opts the optional parameters
|
83
|
+
# @return [nil]
|
84
|
+
describe 'delete_chunk_group test' do
|
85
|
+
it 'should work' do
|
86
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
87
|
+
end
|
88
|
+
end
|
89
|
+
|
90
|
+
# unit tests for delete_group_by_tracking_id
|
91
|
+
# @param tr_dataset The dataset id to use for the request
|
92
|
+
# @param tracking_id Tracking id of the chunk_group to delete
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [nil]
|
95
|
+
describe 'delete_group_by_tracking_id test' do
|
96
|
+
it 'should work' do
|
97
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
98
|
+
end
|
99
|
+
end
|
100
|
+
|
101
|
+
# unit tests for get_chunks_in_group
|
102
|
+
# get_chunks_in_group
|
103
|
+
# 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.
|
104
|
+
# @param tr_dataset The dataset id to use for the request
|
105
|
+
# @param group_id The id of the group to get the chunks from
|
106
|
+
# @param page The page of chunks to get from the group
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @return [BookmarkData]
|
109
|
+
describe 'get_chunks_in_group test' do
|
110
|
+
it 'should work' do
|
111
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
112
|
+
end
|
113
|
+
end
|
114
|
+
|
115
|
+
# unit tests for get_chunks_in_group_by_tracking_id
|
116
|
+
# get_chunks_in_group_by_tracking_id
|
117
|
+
# 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.
|
118
|
+
# @param tr_dataset The dataset id to use for the request
|
119
|
+
# @param group_tracking_id The id of the group to get the chunks from
|
120
|
+
# @param page The page of chunks to get from the group
|
121
|
+
# @param [Hash] opts the optional parameters
|
122
|
+
# @return [BookmarkData]
|
123
|
+
describe 'get_chunks_in_group_by_tracking_id test' do
|
124
|
+
it 'should work' do
|
125
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
# unit tests for get_group_by_tracking_id
|
130
|
+
# get_group_by_tracking_id
|
131
|
+
# get_group_by_tracking_id
|
132
|
+
# @param tr_dataset The dataset id to use for the request
|
133
|
+
# @param tracking_id The tracking id of the group to fetch.
|
134
|
+
# @param [Hash] opts the optional parameters
|
135
|
+
# @return [ChunkGroup]
|
136
|
+
describe 'get_group_by_tracking_id test' do
|
137
|
+
it 'should work' do
|
138
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
# unit tests for get_groups_chunk_is_in
|
143
|
+
# @param tr_dataset The dataset id to use for the request
|
144
|
+
# @param get_groups_for_chunks_data JSON request payload to get the groups that a chunk is in
|
145
|
+
# @param [Hash] opts the optional parameters
|
146
|
+
# @return [Array<BookmarkGroupResult>]
|
147
|
+
describe 'get_groups_chunk_is_in test' do
|
148
|
+
it 'should work' do
|
149
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
# unit tests for get_recommended_groups
|
154
|
+
# @param tr_dataset The dataset id to use for the request
|
155
|
+
# @param reccomend_group_chunks_request JSON request payload to get recommendations of chunks similar to the chunks in the request
|
156
|
+
# @param [Hash] opts the optional parameters
|
157
|
+
# @return [Array<GroupScoreChunkDTO>]
|
158
|
+
describe 'get_recommended_groups test' do
|
159
|
+
it 'should work' do
|
160
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
161
|
+
end
|
162
|
+
end
|
163
|
+
|
164
|
+
# unit tests for get_specific_dataset_chunk_groups
|
165
|
+
# get_dataset_groups
|
166
|
+
# get_dataset_groups Fetch the groups which belong to a dataset specified by its id.
|
167
|
+
# @param tr_dataset The dataset id to use for the request
|
168
|
+
# @param dataset_id The id of the dataset to fetch groups for.
|
169
|
+
# @param page The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @return [GroupData]
|
172
|
+
describe 'get_specific_dataset_chunk_groups test' do
|
173
|
+
it 'should work' do
|
174
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
178
|
+
# unit tests for remove_chunk_from_group
|
179
|
+
# remove_chunk_from_group
|
180
|
+
# remove_chunk_from_group Route to remove a chunk from a group.
|
181
|
+
# @param tr_dataset The dataset id to use for the request
|
182
|
+
# @param group_id Id of the group to remove the bookmark'ed chunk from
|
183
|
+
# @param create_chunk_group_data JSON request payload to cretea a chunkGroup
|
184
|
+
# @param [Hash] opts the optional parameters
|
185
|
+
# @return [nil]
|
186
|
+
describe 'remove_chunk_from_group test' do
|
187
|
+
it 'should work' do
|
188
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
# unit tests for search_over_groups
|
193
|
+
# group_oriented_search
|
194
|
+
# 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.
|
195
|
+
# @param search_over_groups_data JSON request payload to semantically search over groups
|
196
|
+
# @param [Hash] opts the optional parameters
|
197
|
+
# @return [SearchOverGroupsResponseBody]
|
198
|
+
describe 'search_over_groups test' do
|
199
|
+
it 'should work' do
|
200
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
201
|
+
end
|
202
|
+
end
|
203
|
+
|
204
|
+
# unit tests for search_within_group
|
205
|
+
# search_within_group
|
206
|
+
# 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.
|
207
|
+
# @param tr_dataset The dataset id to use for the request
|
208
|
+
# @param search_within_group_data JSON request payload to semantically search a group
|
209
|
+
# @param [Hash] opts the optional parameters
|
210
|
+
# @return [SearchGroupsResult]
|
211
|
+
describe 'search_within_group test' do
|
212
|
+
it 'should work' do
|
213
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
214
|
+
end
|
215
|
+
end
|
216
|
+
|
217
|
+
# unit tests for update_chunk_group
|
218
|
+
# update_chunk_group
|
219
|
+
# update_chunk_group Update a chunk_group.
|
220
|
+
# @param tr_dataset The dataset id to use for the request
|
221
|
+
# @param update_chunk_group_data JSON request payload to update a chunkGroup
|
222
|
+
# @param [Hash] opts the optional parameters
|
223
|
+
# @return [nil]
|
224
|
+
describe 'update_chunk_group test' do
|
225
|
+
it 'should work' do
|
226
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
227
|
+
end
|
228
|
+
end
|
229
|
+
|
230
|
+
# unit tests for update_group_by_tracking_id
|
231
|
+
# @param tr_dataset The dataset id to use for the request
|
232
|
+
# @param tracking_id Tracking id of the chunk_group to update
|
233
|
+
# @param update_group_by_tracking_id_data JSON request payload to update a chunkGroup
|
234
|
+
# @param [Hash] opts the optional parameters
|
235
|
+
# @return [nil]
|
236
|
+
describe 'update_group_by_tracking_id test' do
|
237
|
+
it 'should work' do
|
238
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
end
|
@@ -0,0 +1,113 @@
|
|
1
|
+
=begin
|
2
|
+
#trieve-server
|
3
|
+
|
4
|
+
#Trieve REST API OpenAPI Documentation
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.3.3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::DatasetApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'DatasetApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::DatasetApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of DatasetApi' do
|
30
|
+
it 'should create an instance of DatasetApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::DatasetApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for create_dataset
|
36
|
+
# create_dataset
|
37
|
+
# create_dataset Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
38
|
+
# @param tr_organization The organization id to use for the request
|
39
|
+
# @param create_dataset_request JSON request payload to create a new dataset
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Dataset]
|
42
|
+
describe 'create_dataset test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for delete_dataset
|
49
|
+
# delete_dataset
|
50
|
+
# delete_dataset Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
51
|
+
# @param tr_organization The organization id to use for the request
|
52
|
+
# @param delete_dataset_request JSON request payload to delete a dataset
|
53
|
+
# @param [Hash] opts the optional parameters
|
54
|
+
# @return [nil]
|
55
|
+
describe 'delete_dataset test' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# unit tests for get_client_dataset_config
|
62
|
+
# get_client_dataset_config
|
63
|
+
# get_client_dataset_config Get the client configuration for a dataset. Will use the TR-D
|
64
|
+
# @param tr_dataset The dataset id to use for the request
|
65
|
+
# @param [Hash] opts the optional parameters
|
66
|
+
# @return [ClientDatasetConfiguration]
|
67
|
+
describe 'get_client_dataset_config test' do
|
68
|
+
it 'should work' do
|
69
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
# unit tests for get_dataset
|
74
|
+
# get_dataset
|
75
|
+
# get_dataset Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
|
76
|
+
# @param tr_organization The organization id to use for the request
|
77
|
+
# @param tr_dataset The dataset id to use for the request
|
78
|
+
# @param dataset_id The id of the dataset you want to retrieve.
|
79
|
+
# @param [Hash] opts the optional parameters
|
80
|
+
# @return [Dataset]
|
81
|
+
describe 'get_dataset test' do
|
82
|
+
it 'should work' do
|
83
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
# unit tests for get_datasets_from_organization
|
88
|
+
# get_organization_datasets
|
89
|
+
# 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.
|
90
|
+
# @param tr_organization The organization id to use for the request
|
91
|
+
# @param organization_id id of the organization you want to retrieve datasets for
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [Array<DatasetAndUsage>]
|
94
|
+
describe 'get_datasets_from_organization test' do
|
95
|
+
it 'should work' do
|
96
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
# unit tests for update_dataset
|
101
|
+
# update_dataset
|
102
|
+
# update_dataset Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
103
|
+
# @param tr_organization The organization id to use for the request
|
104
|
+
# @param update_dataset_request JSON request payload to update a dataset
|
105
|
+
# @param [Hash] opts the optional parameters
|
106
|
+
# @return [Dataset]
|
107
|
+
describe 'update_dataset test' do
|
108
|
+
it 'should work' do
|
109
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
=begin
|
2
|
+
#trieve-server
|
3
|
+
|
4
|
+
#Trieve REST API OpenAPI Documentation
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.3.3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for OpenapiClient::EventsApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'EventsApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = OpenapiClient::EventsApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of EventsApi' do
|
30
|
+
it 'should create an instance of EventsApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(OpenapiClient::EventsApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for get_events
|
36
|
+
# get_events
|
37
|
+
# 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.
|
38
|
+
# @param tr_dataset The dataset id to use for the request
|
39
|
+
# @param page Page number of events to get
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [EventReturn]
|
42
|
+
describe 'get_events test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
end
|