trieve_ruby_client 0.8.2 → 0.11.0
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 +4 -4
- data/GENERATE_COMMAND.txt +2 -0
- data/README.md +153 -41
- data/docs/APIVersion.md +15 -0
- data/docs/AnalyticsApi.md +303 -0
- data/docs/ApiKeyRespBody.md +32 -0
- data/docs/AuthApi.md +4 -4
- data/docs/AutocompleteData.md +42 -0
- data/docs/AutocompleteReqPayload.md +54 -0
- data/docs/BookmarkGroupResponse.md +49 -0
- data/docs/BookmarkGroupResult.md +1 -1
- data/docs/BoostPhrase.md +20 -0
- data/docs/ChatMessageProxy.md +1 -1
- data/docs/ChunkApi.md +269 -93
- data/docs/ChunkData.md +3 -1
- data/docs/ChunkFilter.md +5 -3
- data/docs/ChunkGroup.md +1 -1
- data/docs/ChunkGroupAndFileId.md +36 -0
- data/docs/ChunkGroupApi.md +136 -114
- data/docs/ChunkMetadata.md +6 -2
- data/docs/ChunkMetadataStringTagSet.md +46 -0
- data/docs/ChunkMetadataTypes.md +51 -0
- data/docs/ChunkMetadataWithScore.md +1 -1
- data/docs/ChunkReqPayload.md +50 -0
- data/docs/ChunkReturnTypes.md +49 -0
- data/docs/ClientDatasetConfiguration.md +0 -2
- data/docs/ClusterAnalytics.md +63 -0
- data/docs/ClusterAnalyticsFilter.md +18 -0
- data/docs/ClusterAnalyticsResponse.md +49 -0
- data/docs/ClusterQueries.md +22 -0
- data/docs/ClusterTopics.md +20 -0
- data/docs/ConditionType.md +49 -0
- data/docs/ContentChunkMetadata.md +32 -0
- data/docs/CountChunkQueryResponseBody.md +18 -0
- data/docs/CountChunksReqPayload.md +26 -0
- data/docs/CountQueries.md +20 -0
- data/docs/CreateChunkGroupReqPayload.md +28 -0
- data/docs/CreateChunkReqPayloadEnum.md +49 -0
- data/docs/CreateDatasetRequest.md +2 -2
- data/docs/CreateMessageData.md +2 -2
- data/docs/CreateMessageReqPayload.md +52 -0
- data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
- data/docs/CreateTopicReqPayload.md +22 -0
- data/docs/Dataset.md +2 -2
- data/docs/DatasetAnalytics.md +28 -0
- data/docs/DatasetApi.md +184 -32
- data/docs/DatasetDTO.md +0 -2
- data/docs/DateRange.md +24 -0
- data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
- data/docs/DistancePhrase.md +20 -0
- data/docs/EditMessageReqPayload.md +54 -0
- data/docs/Event.md +3 -5
- data/docs/EventTypeRequest.md +15 -0
- data/docs/EventsApi.md +1 -1
- data/docs/FieldCondition.md +2 -0
- data/docs/File.md +1 -1
- data/docs/FileApi.md +10 -10
- data/docs/GenerateChunksRequest.md +13 -1
- data/docs/GeoInfoWithBias.md +20 -0
- data/docs/GetChunksForGroupsResponse.md +22 -0
- data/docs/GetDatasetsPagination.md +20 -0
- data/docs/GetEventsData.md +1 -1
- data/docs/Granularity.md +15 -0
- data/docs/GroupData.md +1 -1
- data/docs/GroupScoreChunk.md +14 -0
- data/docs/GroupsBookmarkQueryResult.md +22 -0
- data/docs/HasIDCondition.md +20 -0
- data/docs/HeadQueries.md +20 -0
- data/docs/HeadQueries1.md +22 -0
- data/docs/HeadQueryResponse.md +18 -0
- data/docs/HealthApi.md +1 -1
- data/docs/InvitationApi.md +1 -1
- data/docs/LatencyGraph.md +22 -0
- data/docs/LatencyGraphResponse.md +18 -0
- data/docs/LowConfidenceQueries.md +24 -0
- data/docs/LowConfidenceRecommendations.md +24 -0
- data/docs/MatchCondition.md +3 -1
- data/docs/MessageApi.md +43 -43
- data/docs/MetricsApi.md +76 -0
- data/docs/NewChunkMetadataTypes.md +51 -0
- data/docs/NoResultQueries.md +22 -0
- data/docs/Organization.md +2 -0
- data/docs/OrganizationApi.md +27 -28
- data/docs/QueryCountResponse.md +18 -0
- data/docs/QueryDetails.md +20 -0
- data/docs/RAGAnalytics.md +63 -0
- data/docs/RAGAnalyticsFilter.md +20 -0
- data/docs/RAGAnalyticsResponse.md +49 -0
- data/docs/RAGQueries.md +26 -0
- data/docs/RAGUsage.md +20 -0
- data/docs/RAGUsageResponse.md +18 -0
- data/docs/RPSGraph.md +22 -0
- data/docs/RPSGraphResponse.md +18 -0
- data/docs/RagQueryEvent.md +30 -0
- data/docs/RagQueryResponse.md +18 -0
- data/docs/RagTypes.md +15 -0
- data/docs/RangeCondition.md +1 -3
- data/docs/RecommendChunksRequest.md +2 -2
- data/docs/RecommendChunksResponseBody.md +18 -0
- data/docs/RecommendGroupChunksRequest.md +2 -2
- data/docs/RecommendGroupsResponse.md +49 -0
- data/docs/RecommendGroupsResponseBody.md +18 -0
- data/docs/RecommendResponseTypes.md +49 -0
- data/docs/RecommendType.md +15 -0
- data/docs/RecommendationAnalytics.md +63 -0
- data/docs/RecommendationAnalyticsFilter.md +20 -0
- data/docs/RecommendationAnalyticsResponse.md +47 -0
- data/docs/RecommendationEvent.md +38 -0
- data/docs/RecommendationQueries.md +26 -0
- data/docs/RecommendationStrategy.md +15 -0
- data/docs/RecommendationType.md +15 -0
- data/docs/RecommendationsEventResponse.md +18 -0
- data/docs/RegenerateMessageReqPayload.md +48 -0
- data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
- data/docs/RoleProxy.md +15 -0
- data/docs/ScoreChunk.md +22 -0
- data/docs/ScoreChunkDTO.md +3 -1
- data/docs/SearchAnalytics.md +77 -0
- data/docs/SearchAnalyticsFilter.md +22 -0
- data/docs/SearchAnalyticsResponse.md +59 -0
- data/docs/SearchChunkData.md +9 -3
- data/docs/SearchChunksReqPayload.md +56 -0
- data/docs/SearchClusterResponse.md +18 -0
- data/docs/SearchClusterTopics.md +28 -0
- data/docs/SearchGroupResponseTypes.md +49 -0
- data/docs/SearchLatencyGraph.md +20 -0
- data/docs/SearchMethod.md +15 -0
- data/docs/SearchMetrics.md +20 -0
- data/docs/SearchOverGroupsData.md +12 -6
- data/docs/SearchOverGroupsResponseBody.md +4 -4
- data/docs/SearchOverGroupsResponseTypes.md +4 -4
- data/docs/SearchOverGroupsResults.md +6 -4
- data/docs/SearchQueries.md +26 -0
- data/docs/SearchQueryEvent.md +34 -0
- data/docs/SearchQueryResponse.md +18 -0
- data/docs/SearchRPSGraph.md +20 -0
- data/docs/SearchResponseBody.md +20 -0
- data/docs/SearchResponseTypes.md +49 -0
- data/docs/SearchResultType.md +49 -0
- data/docs/SearchType.md +15 -0
- data/docs/SearchTypeCount.md +22 -0
- data/docs/SearchWithinGroupData.md +18 -4
- data/docs/SearchWithinGroupResponseBody.md +20 -0
- data/docs/SearchWithinGroupResults.md +1 -1
- data/docs/SetUserApiKeyRequest.md +4 -0
- data/docs/SlimChunkMetadata.md +5 -1
- data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
- data/docs/SlimChunkMetadataWithScore.md +1 -1
- data/docs/SortBy.md +15 -0
- data/docs/SortOrder.md +15 -0
- data/docs/StripeApi.md +134 -4
- data/docs/StripeInvoice.md +28 -0
- data/docs/SuggestedQueriesReqPayload.md +18 -0
- data/docs/TopicApi.md +16 -16
- data/docs/UpdateChunkData.md +2 -0
- data/docs/UpdateChunkGroupData.md +3 -1
- data/docs/UpdateChunkReqPayload.md +48 -0
- data/docs/UpdateDatasetRequest.md +2 -0
- data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
- data/docs/UpdateTopicReqPayload.md +20 -0
- data/docs/UpdateUserOrgRoleData.md +1 -1
- data/docs/UploadFileReqPayload.md +40 -0
- data/docs/UserApi.md +9 -10
- data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
- data/lib/trieve_ruby_client/api/chunk_api.rb +274 -103
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +161 -139
- data/lib/trieve_ruby_client/api/dataset_api.rb +183 -38
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +18 -18
- data/lib/trieve_ruby_client/api/health_api.rb +3 -3
- data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
- data/lib/trieve_ruby_client/api/message_api.rb +52 -52
- data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +33 -33
- data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
- data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
- data/lib/trieve_ruby_client/api/user_api.rb +12 -12
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +8 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
- data/lib/trieve_ruby_client/models/api_version.rb +40 -0
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
- data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +509 -0
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
- data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
- data/lib/trieve_ruby_client/models/chunk_data.rb +16 -9
- data/lib/trieve_ruby_client/models/chunk_filter.rb +16 -5
- data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +35 -5
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +393 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +397 -0
- data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
- data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
- data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
- data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +305 -0
- data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
- data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
- data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
- data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +469 -0
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
- data/lib/trieve_ruby_client/models/dataset.rb +18 -14
- data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/date_range.rb +245 -0
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +486 -0
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +12 -24
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
- data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
- data/lib/trieve_ruby_client/models/file.rb +5 -3
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +89 -6
- data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
- data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
- data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
- data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
- data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/granularity.rb +42 -0
- data/lib/trieve_ruby_client/models/group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
- data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
- data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
- data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
- data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
- data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
- data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
- data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
- data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
- data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
- data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
- data/lib/trieve_ruby_client/models/organization.rb +18 -2
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
- data/lib/trieve_ruby_client/models/query_details.rb +271 -0
- data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
- data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
- data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
- data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
- data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
- data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +441 -0
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
- data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
- data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
- data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
- data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +40 -5
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +535 -0
- data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
- data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_method.rb +42 -0
- data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +117 -18
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
- data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
- data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
- data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_type.rb +42 -0
- data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +151 -7
- data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +31 -3
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
- data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
- data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +386 -0
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +110 -24
- data/openapi-generator.yaml +2 -2
- data/openapi.json +4491 -1230
- data/spec/api/analytics_api_spec.rb +87 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/models/api_key_resp_body_spec.rb +78 -0
- data/spec/models/api_version_spec.rb +30 -0
- data/spec/models/autocomplete_data_spec.rb +108 -0
- data/spec/models/autocomplete_req_payload_spec.rb +132 -0
- data/spec/models/bookmark_group_response_spec.rb +32 -0
- data/spec/models/boost_phrase_spec.rb +42 -0
- data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
- data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
- data/spec/models/chunk_metadata_types_spec.rb +32 -0
- data/spec/models/chunk_req_payload_spec.rb +132 -0
- data/spec/models/chunk_return_types_spec.rb +32 -0
- data/spec/models/cluster_analytics_filter_spec.rb +36 -0
- data/spec/models/cluster_analytics_response_spec.rb +32 -0
- data/spec/models/cluster_analytics_spec.rb +38 -0
- data/spec/models/cluster_queries_spec.rb +52 -0
- data/spec/models/cluster_topics_spec.rb +46 -0
- data/spec/models/condition_type_spec.rb +32 -0
- data/spec/models/content_chunk_metadata_spec.rb +72 -0
- data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
- data/spec/models/count_chunks_req_payload_spec.rb +60 -0
- data/spec/models/count_queries_spec.rb +46 -0
- data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
- data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
- data/spec/models/create_message_req_payload_spec.rb +108 -0
- data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
- data/spec/models/create_topic_req_payload_spec.rb +48 -0
- data/spec/models/dataset_analytics_spec.rb +66 -0
- data/spec/models/date_range_spec.rb +54 -0
- data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
- data/spec/models/distance_phrase_spec.rb +42 -0
- data/spec/models/edit_message_req_payload_spec.rb +114 -0
- data/spec/models/event_type_request_spec.rb +30 -0
- data/spec/models/geo_info_with_bias_spec.rb +42 -0
- data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
- data/spec/models/get_datasets_pagination_spec.rb +42 -0
- data/spec/models/granularity_spec.rb +30 -0
- data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
- data/spec/models/has_id_condition_spec.rb +42 -0
- data/spec/models/head_queries1_spec.rb +52 -0
- data/spec/models/head_queries_spec.rb +42 -0
- data/spec/models/head_query_response_spec.rb +36 -0
- data/spec/models/latency_graph_response_spec.rb +36 -0
- data/spec/models/latency_graph_spec.rb +52 -0
- data/spec/models/low_confidence_queries_spec.rb +58 -0
- data/spec/models/low_confidence_recommendations_spec.rb +58 -0
- data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
- data/spec/models/no_result_queries_spec.rb +52 -0
- data/spec/models/query_count_response_spec.rb +36 -0
- data/spec/models/query_details_spec.rb +46 -0
- data/spec/models/rag_analytics_filter_spec.rb +42 -0
- data/spec/models/rag_analytics_response_spec.rb +32 -0
- data/spec/models/rag_analytics_spec.rb +38 -0
- data/spec/models/rag_queries_spec.rb +64 -0
- data/spec/models/rag_query_event_spec.rb +72 -0
- data/spec/models/rag_query_response_spec.rb +36 -0
- data/spec/models/rag_types_spec.rb +30 -0
- data/spec/models/rag_usage_response_spec.rb +36 -0
- data/spec/models/rag_usage_spec.rb +46 -0
- data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_spec.rb +32 -0
- data/spec/models/recommend_response_types_spec.rb +32 -0
- data/spec/models/recommend_type_spec.rb +30 -0
- data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
- data/spec/models/recommendation_analytics_response_spec.rb +32 -0
- data/spec/models/recommendation_analytics_spec.rb +38 -0
- data/spec/models/recommendation_event_spec.rb +96 -0
- data/spec/models/recommendation_queries_spec.rb +64 -0
- data/spec/models/recommendation_strategy_spec.rb +30 -0
- data/spec/models/recommendation_type_spec.rb +30 -0
- data/spec/models/recommendations_event_response_spec.rb +36 -0
- data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
- data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
- data/spec/models/role_proxy_spec.rb +30 -0
- data/spec/models/rps_graph_response_spec.rb +36 -0
- data/spec/models/rps_graph_spec.rb +52 -0
- data/spec/models/score_chunk_spec.rb +48 -0
- data/spec/models/search_analytics_filter_spec.rb +48 -0
- data/spec/models/search_analytics_response_spec.rb +32 -0
- data/spec/models/search_analytics_spec.rb +38 -0
- data/spec/models/search_chunks_req_payload_spec.rb +144 -0
- data/spec/models/search_cluster_response_spec.rb +36 -0
- data/spec/models/search_cluster_topics_spec.rb +66 -0
- data/spec/models/search_group_response_types_spec.rb +32 -0
- data/spec/models/search_latency_graph_spec.rb +42 -0
- data/spec/models/search_method_spec.rb +30 -0
- data/spec/models/search_metrics_spec.rb +46 -0
- data/spec/models/search_queries_spec.rb +64 -0
- data/spec/models/search_query_event_spec.rb +84 -0
- data/spec/models/search_query_response_spec.rb +36 -0
- data/spec/models/search_response_body_spec.rb +42 -0
- data/spec/models/search_response_types_spec.rb +32 -0
- data/spec/models/search_result_type_spec.rb +32 -0
- data/spec/models/search_rps_graph_spec.rb +42 -0
- data/spec/models/search_type_count_spec.rb +48 -0
- data/spec/models/search_type_spec.rb +30 -0
- data/spec/models/search_within_group_response_body_spec.rb +42 -0
- data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
- data/spec/models/sort_by_spec.rb +30 -0
- data/spec/models/sort_order_spec.rb +30 -0
- data/spec/models/stripe_invoice_spec.rb +66 -0
- data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
- data/spec/models/update_chunk_req_payload_spec.rb +120 -0
- data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
- data/spec/models/update_topic_req_payload_spec.rb +42 -0
- data/spec/models/upload_file_req_payload_spec.rb +102 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client.gemspec +1 -1
- metadata +534 -111
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client-0.6.2.gem +0 -0
- data/trieve_ruby_client-0.6.7.gem +0 -0
- data/trieve_ruby_client-0.6.9.gem +0 -0
- data/trieve_ruby_client-0.7.2.gem +0 -0
- data/trieve_ruby_client-0.7.6.gem +0 -0
- data/trieve_ruby_client-0.8.0.gem +0 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -19,8 +19,78 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Clear Dataset
|
23
|
+
# Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
|
24
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
25
|
+
# @param dataset_id [String] The id of the dataset you want to clear.
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [nil]
|
28
|
+
def clear_dataset(tr_dataset, dataset_id, opts = {})
|
29
|
+
clear_dataset_with_http_info(tr_dataset, dataset_id, opts)
|
30
|
+
nil
|
31
|
+
end
|
32
|
+
|
33
|
+
# Clear Dataset
|
34
|
+
# Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
|
35
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
36
|
+
# @param dataset_id [String] The id of the dataset you want to clear.
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
|
+
def clear_dataset_with_http_info(tr_dataset, dataset_id, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: DatasetApi.clear_dataset ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'tr_dataset' is set
|
44
|
+
if @api_client.config.client_side_validation && tr_dataset.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.clear_dataset"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'dataset_id' is set
|
48
|
+
if @api_client.config.client_side_validation && dataset_id.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.clear_dataset"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/api/dataset/clear/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s))
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
header_params[:'TR-Dataset'] = tr_dataset
|
62
|
+
|
63
|
+
# form parameters
|
64
|
+
form_params = opts[:form_params] || {}
|
65
|
+
|
66
|
+
# http body (model)
|
67
|
+
post_body = opts[:debug_body]
|
68
|
+
|
69
|
+
# return_type
|
70
|
+
return_type = opts[:debug_return_type]
|
71
|
+
|
72
|
+
# auth_names
|
73
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
74
|
+
|
75
|
+
new_options = opts.merge(
|
76
|
+
:operation => :"DatasetApi.clear_dataset",
|
77
|
+
:header_params => header_params,
|
78
|
+
:query_params => query_params,
|
79
|
+
:form_params => form_params,
|
80
|
+
:body => post_body,
|
81
|
+
:auth_names => auth_names,
|
82
|
+
:return_type => return_type
|
83
|
+
)
|
84
|
+
|
85
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug "API called: DatasetApi#clear_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
88
|
+
end
|
89
|
+
return data, status_code, headers
|
90
|
+
end
|
91
|
+
|
22
92
|
# Create dataset
|
23
|
-
# Create
|
93
|
+
# Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
24
94
|
# @param tr_organization [String] The organization id to use for the request
|
25
95
|
# @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
|
26
96
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +101,7 @@ module TrieveRubyClient
|
|
31
101
|
end
|
32
102
|
|
33
103
|
# Create dataset
|
34
|
-
# Create
|
104
|
+
# Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
35
105
|
# @param tr_organization [String] The organization id to use for the request
|
36
106
|
# @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
|
37
107
|
# @param [Hash] opts the optional parameters
|
@@ -95,7 +165,7 @@ module TrieveRubyClient
|
|
95
165
|
end
|
96
166
|
|
97
167
|
# Delete Dataset
|
98
|
-
# Delete
|
168
|
+
# Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
99
169
|
# @param tr_dataset [String] The dataset id to use for the request
|
100
170
|
# @param dataset_id [String] The id of the dataset you want to delete.
|
101
171
|
# @param [Hash] opts the optional parameters
|
@@ -106,7 +176,7 @@ module TrieveRubyClient
|
|
106
176
|
end
|
107
177
|
|
108
178
|
# Delete Dataset
|
109
|
-
# Delete
|
179
|
+
# Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
110
180
|
# @param tr_dataset [String] The dataset id to use for the request
|
111
181
|
# @param dataset_id [String] The id of the dataset you want to delete.
|
112
182
|
# @param [Hash] opts the optional parameters
|
@@ -164,31 +234,37 @@ module TrieveRubyClient
|
|
164
234
|
return data, status_code, headers
|
165
235
|
end
|
166
236
|
|
167
|
-
#
|
168
|
-
#
|
237
|
+
# Delete Dataset by Tracking ID
|
238
|
+
# Delete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.
|
169
239
|
# @param tr_dataset [String] The dataset id to use for the request
|
240
|
+
# @param tracking_id [String] The tracking id of the dataset you want to delete.
|
170
241
|
# @param [Hash] opts the optional parameters
|
171
|
-
# @return [
|
172
|
-
def
|
173
|
-
|
174
|
-
|
242
|
+
# @return [nil]
|
243
|
+
def delete_dataset_by_tracking_id(tr_dataset, tracking_id, opts = {})
|
244
|
+
delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
|
245
|
+
nil
|
175
246
|
end
|
176
247
|
|
177
|
-
#
|
178
|
-
#
|
248
|
+
# Delete Dataset by Tracking ID
|
249
|
+
# Delete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.
|
179
250
|
# @param tr_dataset [String] The dataset id to use for the request
|
251
|
+
# @param tracking_id [String] The tracking id of the dataset you want to delete.
|
180
252
|
# @param [Hash] opts the optional parameters
|
181
|
-
# @return [Array<(
|
182
|
-
def
|
253
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
254
|
+
def delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
|
183
255
|
if @api_client.config.debugging
|
184
|
-
@api_client.config.logger.debug 'Calling API: DatasetApi.
|
256
|
+
@api_client.config.logger.debug 'Calling API: DatasetApi.delete_dataset_by_tracking_id ...'
|
185
257
|
end
|
186
258
|
# verify the required parameter 'tr_dataset' is set
|
187
259
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
188
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.
|
260
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.delete_dataset_by_tracking_id"
|
261
|
+
end
|
262
|
+
# verify the required parameter 'tracking_id' is set
|
263
|
+
if @api_client.config.client_side_validation && tracking_id.nil?
|
264
|
+
fail ArgumentError, "Missing the required parameter 'tracking_id' when calling DatasetApi.delete_dataset_by_tracking_id"
|
189
265
|
end
|
190
266
|
# resource path
|
191
|
-
local_var_path = '/api/dataset/
|
267
|
+
local_var_path = '/api/dataset/tracking_id/{tracking_id}'.sub('{' + 'tracking_id' + '}', CGI.escape(tracking_id.to_s))
|
192
268
|
|
193
269
|
# query parameters
|
194
270
|
query_params = opts[:query_params] || {}
|
@@ -206,13 +282,13 @@ module TrieveRubyClient
|
|
206
282
|
post_body = opts[:debug_body]
|
207
283
|
|
208
284
|
# return_type
|
209
|
-
return_type = opts[:debug_return_type]
|
285
|
+
return_type = opts[:debug_return_type]
|
210
286
|
|
211
287
|
# auth_names
|
212
288
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
213
289
|
|
214
290
|
new_options = opts.merge(
|
215
|
-
:operation => :"DatasetApi.
|
291
|
+
:operation => :"DatasetApi.delete_dataset_by_tracking_id",
|
216
292
|
:header_params => header_params,
|
217
293
|
:query_params => query_params,
|
218
294
|
:form_params => form_params,
|
@@ -221,40 +297,34 @@ module TrieveRubyClient
|
|
221
297
|
:return_type => return_type
|
222
298
|
)
|
223
299
|
|
224
|
-
data, status_code, headers = @api_client.call_api(:
|
300
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
225
301
|
if @api_client.config.debugging
|
226
|
-
@api_client.config.logger.debug "API called: DatasetApi#
|
302
|
+
@api_client.config.logger.debug "API called: DatasetApi#delete_dataset_by_tracking_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
227
303
|
end
|
228
304
|
return data, status_code, headers
|
229
305
|
end
|
230
306
|
|
231
307
|
# Get Dataset
|
232
|
-
# Get
|
233
|
-
# @param tr_organization [String] The organization id to use for the request
|
308
|
+
# Get a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
234
309
|
# @param tr_dataset [String] The dataset id to use for the request
|
235
310
|
# @param dataset_id [String] The id of the dataset you want to retrieve.
|
236
311
|
# @param [Hash] opts the optional parameters
|
237
312
|
# @return [Dataset]
|
238
|
-
def get_dataset(
|
239
|
-
data, _status_code, _headers = get_dataset_with_http_info(
|
313
|
+
def get_dataset(tr_dataset, dataset_id, opts = {})
|
314
|
+
data, _status_code, _headers = get_dataset_with_http_info(tr_dataset, dataset_id, opts)
|
240
315
|
data
|
241
316
|
end
|
242
317
|
|
243
318
|
# Get Dataset
|
244
|
-
# Get
|
245
|
-
# @param tr_organization [String] The organization id to use for the request
|
319
|
+
# Get a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
246
320
|
# @param tr_dataset [String] The dataset id to use for the request
|
247
321
|
# @param dataset_id [String] The id of the dataset you want to retrieve.
|
248
322
|
# @param [Hash] opts the optional parameters
|
249
323
|
# @return [Array<(Dataset, Integer, Hash)>] Dataset data, response status code and response headers
|
250
|
-
def get_dataset_with_http_info(
|
324
|
+
def get_dataset_with_http_info(tr_dataset, dataset_id, opts = {})
|
251
325
|
if @api_client.config.debugging
|
252
326
|
@api_client.config.logger.debug 'Calling API: DatasetApi.get_dataset ...'
|
253
327
|
end
|
254
|
-
# verify the required parameter 'tr_organization' is set
|
255
|
-
if @api_client.config.client_side_validation && tr_organization.nil?
|
256
|
-
fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.get_dataset"
|
257
|
-
end
|
258
328
|
# verify the required parameter 'tr_dataset' is set
|
259
329
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
260
330
|
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_dataset"
|
@@ -273,7 +343,6 @@ module TrieveRubyClient
|
|
273
343
|
header_params = opts[:header_params] || {}
|
274
344
|
# HTTP header 'Accept' (if needed)
|
275
345
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
276
|
-
header_params[:'TR-Organization'] = tr_organization
|
277
346
|
header_params[:'TR-Dataset'] = tr_dataset
|
278
347
|
|
279
348
|
# form parameters
|
@@ -306,10 +375,12 @@ module TrieveRubyClient
|
|
306
375
|
end
|
307
376
|
|
308
377
|
# Get Datasets from Organization
|
309
|
-
# Get
|
378
|
+
# Get all datasets for an organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
310
379
|
# @param tr_organization [String] The organization id to use for the request
|
311
380
|
# @param organization_id [String] id of the organization you want to retrieve datasets for
|
312
381
|
# @param [Hash] opts the optional parameters
|
382
|
+
# @option opts [Integer] :limit The number of records to return
|
383
|
+
# @option opts [Integer] :offset The number of records to skip
|
313
384
|
# @return [Array<DatasetAndUsage>]
|
314
385
|
def get_datasets_from_organization(tr_organization, organization_id, opts = {})
|
315
386
|
data, _status_code, _headers = get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
|
@@ -317,10 +388,12 @@ module TrieveRubyClient
|
|
317
388
|
end
|
318
389
|
|
319
390
|
# Get Datasets from Organization
|
320
|
-
# Get
|
391
|
+
# Get all datasets for an organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
321
392
|
# @param tr_organization [String] The organization id to use for the request
|
322
393
|
# @param organization_id [String] id of the organization you want to retrieve datasets for
|
323
394
|
# @param [Hash] opts the optional parameters
|
395
|
+
# @option opts [Integer] :limit The number of records to return
|
396
|
+
# @option opts [Integer] :offset The number of records to skip
|
324
397
|
# @return [Array<(Array<DatasetAndUsage>, Integer, Hash)>] Array<DatasetAndUsage> data, response status code and response headers
|
325
398
|
def get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts = {})
|
326
399
|
if @api_client.config.debugging
|
@@ -339,6 +412,8 @@ module TrieveRubyClient
|
|
339
412
|
|
340
413
|
# query parameters
|
341
414
|
query_params = opts[:query_params] || {}
|
415
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
416
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
342
417
|
|
343
418
|
# header parameters
|
344
419
|
header_params = opts[:header_params] || {}
|
@@ -375,8 +450,78 @@ module TrieveRubyClient
|
|
375
450
|
return data, status_code, headers
|
376
451
|
end
|
377
452
|
|
453
|
+
# Get Usage By Dataset ID
|
454
|
+
# Get the usage for a dataset by its id.
|
455
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
456
|
+
# @param dataset_id [String] The id of the dataset you want to retrieve usage for.
|
457
|
+
# @param [Hash] opts the optional parameters
|
458
|
+
# @return [DatasetUsageCount]
|
459
|
+
def get_usage_by_dataset_id(tr_dataset, dataset_id, opts = {})
|
460
|
+
data, _status_code, _headers = get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id, opts)
|
461
|
+
data
|
462
|
+
end
|
463
|
+
|
464
|
+
# Get Usage By Dataset ID
|
465
|
+
# Get the usage for a dataset by its id.
|
466
|
+
# @param tr_dataset [String] The dataset id to use for the request
|
467
|
+
# @param dataset_id [String] The id of the dataset you want to retrieve usage for.
|
468
|
+
# @param [Hash] opts the optional parameters
|
469
|
+
# @return [Array<(DatasetUsageCount, Integer, Hash)>] DatasetUsageCount data, response status code and response headers
|
470
|
+
def get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id, opts = {})
|
471
|
+
if @api_client.config.debugging
|
472
|
+
@api_client.config.logger.debug 'Calling API: DatasetApi.get_usage_by_dataset_id ...'
|
473
|
+
end
|
474
|
+
# verify the required parameter 'tr_dataset' is set
|
475
|
+
if @api_client.config.client_side_validation && tr_dataset.nil?
|
476
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_usage_by_dataset_id"
|
477
|
+
end
|
478
|
+
# verify the required parameter 'dataset_id' is set
|
479
|
+
if @api_client.config.client_side_validation && dataset_id.nil?
|
480
|
+
fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.get_usage_by_dataset_id"
|
481
|
+
end
|
482
|
+
# resource path
|
483
|
+
local_var_path = '/api/dataset/usage/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s))
|
484
|
+
|
485
|
+
# query parameters
|
486
|
+
query_params = opts[:query_params] || {}
|
487
|
+
|
488
|
+
# header parameters
|
489
|
+
header_params = opts[:header_params] || {}
|
490
|
+
# HTTP header 'Accept' (if needed)
|
491
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
492
|
+
header_params[:'TR-Dataset'] = tr_dataset
|
493
|
+
|
494
|
+
# form parameters
|
495
|
+
form_params = opts[:form_params] || {}
|
496
|
+
|
497
|
+
# http body (model)
|
498
|
+
post_body = opts[:debug_body]
|
499
|
+
|
500
|
+
# return_type
|
501
|
+
return_type = opts[:debug_return_type] || 'DatasetUsageCount'
|
502
|
+
|
503
|
+
# auth_names
|
504
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
505
|
+
|
506
|
+
new_options = opts.merge(
|
507
|
+
:operation => :"DatasetApi.get_usage_by_dataset_id",
|
508
|
+
:header_params => header_params,
|
509
|
+
:query_params => query_params,
|
510
|
+
:form_params => form_params,
|
511
|
+
:body => post_body,
|
512
|
+
:auth_names => auth_names,
|
513
|
+
:return_type => return_type
|
514
|
+
)
|
515
|
+
|
516
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
517
|
+
if @api_client.config.debugging
|
518
|
+
@api_client.config.logger.debug "API called: DatasetApi#get_usage_by_dataset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
519
|
+
end
|
520
|
+
return data, status_code, headers
|
521
|
+
end
|
522
|
+
|
378
523
|
# Update Dataset
|
379
|
-
# Update
|
524
|
+
# Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
380
525
|
# @param tr_organization [String] The organization id to use for the request
|
381
526
|
# @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
|
382
527
|
# @param [Hash] opts the optional parameters
|
@@ -387,7 +532,7 @@ module TrieveRubyClient
|
|
387
532
|
end
|
388
533
|
|
389
534
|
# Update Dataset
|
390
|
-
# Update
|
535
|
+
# Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
391
536
|
# @param tr_organization [String] The organization id to use for the request
|
392
537
|
# @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
|
393
538
|
# @param [Hash] opts the optional parameters
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Get events for the dataset
|
23
|
-
# Get events for the dataset
|
23
|
+
# Get events for the dataset specified by the TR-Dataset header.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Get events for the dataset
|
34
|
-
# Get events for the dataset
|
34
|
+
# Get events for the dataset specified by the TR-Dataset header.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param get_events_data [GetEventsData] JSON request payload to get events for a dataset
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Delete File
|
23
|
-
# Delete
|
23
|
+
# Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param file_id [String] The id of the file to delete
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Delete File
|
34
|
-
# Delete
|
34
|
+
# Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param file_id [String] The id of the file to delete
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -90,7 +90,7 @@ module TrieveRubyClient
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Get Files for Dataset
|
93
|
-
# Get
|
93
|
+
# Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
|
94
94
|
# @param tr_dataset [String] The dataset id to use for the request
|
95
95
|
# @param dataset_id [String] The id of the dataset to fetch files for.
|
96
96
|
# @param page [Integer] The page number of files you wish to fetch. Each page contains at most 10 files.
|
@@ -102,7 +102,7 @@ module TrieveRubyClient
|
|
102
102
|
end
|
103
103
|
|
104
104
|
# Get Files for Dataset
|
105
|
-
# Get
|
105
|
+
# Get all files which belong to a given dataset specified by the dataset_id parameter. 10 files are returned per page.
|
106
106
|
# @param tr_dataset [String] The dataset id to use for the request
|
107
107
|
# @param dataset_id [String] The id of the dataset to fetch files for.
|
108
108
|
# @param page [Integer] The page number of files you wish to fetch. Each page contains at most 10 files.
|
@@ -170,7 +170,7 @@ module TrieveRubyClient
|
|
170
170
|
end
|
171
171
|
|
172
172
|
# Get File
|
173
|
-
#
|
173
|
+
# Download a file based on its id.
|
174
174
|
# @param tr_dataset [String] The dataset id to use for the request
|
175
175
|
# @param file_id [String] The id of the file to fetch
|
176
176
|
# @param [Hash] opts the optional parameters
|
@@ -181,7 +181,7 @@ module TrieveRubyClient
|
|
181
181
|
end
|
182
182
|
|
183
183
|
# Get File
|
184
|
-
#
|
184
|
+
# Download a file based on its id.
|
185
185
|
# @param tr_dataset [String] The dataset id to use for the request
|
186
186
|
# @param file_id [String] The id of the file to fetch
|
187
187
|
# @param [Hash] opts the optional parameters
|
@@ -240,23 +240,23 @@ module TrieveRubyClient
|
|
240
240
|
end
|
241
241
|
|
242
242
|
# Upload File
|
243
|
-
# Upload
|
243
|
+
# 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.
|
244
244
|
# @param tr_dataset [String] The dataset id to use for the request
|
245
|
-
# @param
|
245
|
+
# @param upload_file_req_payload [UploadFileReqPayload] JSON request payload to upload a file
|
246
246
|
# @param [Hash] opts the optional parameters
|
247
247
|
# @return [UploadFileResult]
|
248
|
-
def upload_file_handler(tr_dataset,
|
249
|
-
data, _status_code, _headers = upload_file_handler_with_http_info(tr_dataset,
|
248
|
+
def upload_file_handler(tr_dataset, upload_file_req_payload, opts = {})
|
249
|
+
data, _status_code, _headers = upload_file_handler_with_http_info(tr_dataset, upload_file_req_payload, opts)
|
250
250
|
data
|
251
251
|
end
|
252
252
|
|
253
253
|
# Upload File
|
254
|
-
# Upload
|
254
|
+
# 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.
|
255
255
|
# @param tr_dataset [String] The dataset id to use for the request
|
256
|
-
# @param
|
256
|
+
# @param upload_file_req_payload [UploadFileReqPayload] JSON request payload to upload a file
|
257
257
|
# @param [Hash] opts the optional parameters
|
258
258
|
# @return [Array<(UploadFileResult, Integer, Hash)>] UploadFileResult data, response status code and response headers
|
259
|
-
def upload_file_handler_with_http_info(tr_dataset,
|
259
|
+
def upload_file_handler_with_http_info(tr_dataset, upload_file_req_payload, opts = {})
|
260
260
|
if @api_client.config.debugging
|
261
261
|
@api_client.config.logger.debug 'Calling API: FileApi.upload_file_handler ...'
|
262
262
|
end
|
@@ -264,9 +264,9 @@ module TrieveRubyClient
|
|
264
264
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
265
265
|
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling FileApi.upload_file_handler"
|
266
266
|
end
|
267
|
-
# verify the required parameter '
|
268
|
-
if @api_client.config.client_side_validation &&
|
269
|
-
fail ArgumentError, "Missing the required parameter '
|
267
|
+
# verify the required parameter 'upload_file_req_payload' is set
|
268
|
+
if @api_client.config.client_side_validation && upload_file_req_payload.nil?
|
269
|
+
fail ArgumentError, "Missing the required parameter 'upload_file_req_payload' when calling FileApi.upload_file_handler"
|
270
270
|
end
|
271
271
|
# resource path
|
272
272
|
local_var_path = '/api/file'
|
@@ -289,7 +289,7 @@ module TrieveRubyClient
|
|
289
289
|
form_params = opts[:form_params] || {}
|
290
290
|
|
291
291
|
# http body (model)
|
292
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
292
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_file_req_payload)
|
293
293
|
|
294
294
|
# return_type
|
295
295
|
return_type = opts[:debug_return_type] || 'UploadFileResult'
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Health Check
|
23
|
-
#
|
23
|
+
# Confirmation that the service is healthy and can make embedding vectors
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [nil]
|
26
26
|
def health_check(opts = {})
|
@@ -29,7 +29,7 @@ module TrieveRubyClient
|
|
29
29
|
end
|
30
30
|
|
31
31
|
# Health Check
|
32
|
-
#
|
32
|
+
# Confirmation that the service is healthy and can make embedding vectors
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
34
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
35
35
|
def health_check_with_http_info(opts = {})
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Send Invitation
|
23
|
-
#
|
23
|
+
# 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. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
24
24
|
# @param tr_organization [String] The organization id to use for the request
|
25
25
|
# @param invitation_data [InvitationData] JSON request payload to send an invitation
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Send Invitation
|
34
|
-
#
|
34
|
+
# 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. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
35
35
|
# @param tr_organization [String] The organization id to use for the request
|
36
36
|
# @param invitation_data [InvitationData] JSON request payload to send an invitation
|
37
37
|
# @param [Hash] opts the optional parameters
|