trieve_ruby_client 0.10.7 → 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 +119 -16
- data/docs/APIVersion.md +15 -0
- data/docs/AnalyticsApi.md +303 -0
- data/docs/AuthApi.md +4 -4
- data/docs/AutocompleteReqPayload.md +6 -2
- data/docs/BookmarkGroupResponse.md +49 -0
- data/docs/BookmarkGroupResult.md +1 -1
- data/docs/ChatMessageProxy.md +1 -1
- data/docs/ChunkApi.md +165 -63
- data/docs/ChunkFilter.md +2 -0
- data/docs/ChunkGroupAndFileId.md +36 -0
- data/docs/ChunkGroupApi.md +110 -90
- data/docs/ChunkMetadata.md +1 -1
- data/docs/ChunkMetadataStringTagSet.md +1 -1
- data/docs/ChunkMetadataWithScore.md +1 -1
- data/docs/ChunkReqPayload.md +2 -2
- data/docs/ChunkReturnTypes.md +49 -0
- 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/ContentChunkMetadata.md +1 -1
- data/docs/CountChunkQueryResponseBody.md +18 -0
- data/docs/CountChunksReqPayload.md +26 -0
- data/docs/CountQueries.md +20 -0
- data/docs/CreateMessageReqPayload.md +11 -1
- data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
- data/docs/Dataset.md +0 -2
- data/docs/DatasetAnalytics.md +28 -0
- data/docs/DatasetApi.md +8 -80
- data/docs/DatasetDTO.md +0 -2
- data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
- data/docs/DistancePhrase.md +20 -0
- data/docs/EditMessageReqPayload.md +11 -1
- data/docs/Event.md +3 -5
- data/docs/EventTypeRequest.md +15 -0
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +4 -4
- data/docs/GenerateChunksRequest.md +11 -1
- data/docs/GeoInfoWithBias.md +20 -0
- data/docs/GetChunksForGroupsResponse.md +22 -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/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/MessageApi.md +4 -4
- data/docs/MetricsApi.md +76 -0
- data/docs/NewChunkMetadataTypes.md +51 -0
- data/docs/NoResultQueries.md +22 -0
- data/docs/OrganizationApi.md +6 -6
- 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/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 +9 -1
- data/docs/RoleProxy.md +15 -0
- data/docs/ScoreChunk.md +22 -0
- data/docs/SearchAnalytics.md +77 -0
- data/docs/SearchAnalyticsFilter.md +22 -0
- data/docs/SearchAnalyticsResponse.md +59 -0
- data/docs/SearchChunksReqPayload.md +6 -4
- 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 +2 -4
- 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 +6 -2
- data/docs/SearchWithinGroupResponseBody.md +20 -0
- data/docs/SearchWithinGroupResults.md +1 -1
- data/docs/SlimChunkMetadata.md +1 -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/TopicApi.md +4 -4
- data/docs/UpdateChunkGroupData.md +3 -1
- data/docs/UpdateChunkReqPayload.md +2 -0
- data/docs/UserApi.md +3 -3
- 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 +148 -52
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +122 -107
- data/lib/trieve_ruby_client/api/dataset_api.rb +17 -81
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +9 -9
- 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 +9 -9
- data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +13 -13
- data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
- data/lib/trieve_ruby_client/api/topic_api.rb +9 -9
- data/lib/trieve_ruby_client/api/user_api.rb +7 -7
- 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_resp_body.rb +1 -1
- 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_req_payload.rb +47 -5
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.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 +1 -1
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
- data/lib/trieve_ruby_client/models/chunk_filter.rb +13 -2
- data/lib/trieve_ruby_client/models/chunk_group.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 +8 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +12 -15
- data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
- 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 +1 -1
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +8 -2
- 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_group_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +1 -1
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +95 -4
- 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_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset.rb +2 -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 +1 -1
- 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_req_payload.rb +95 -4
- 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 +1 -1
- data/lib/trieve_ruby_client/models/file.rb +1 -1
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +78 -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 +1 -1
- 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 +1 -1
- 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 +1 -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 +1 -1
- 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 +1 -1
- 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_req_payload.rb +84 -4
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +1 -1
- 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 +1 -1
- 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_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +47 -16
- 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 +26 -16
- 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 +47 -5
- 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 +1 -1
- 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 +8 -2
- 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_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 +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_group_data.rb +17 -6
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +12 -2
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +1 -1
- 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 +86 -5
- data/openapi-generator.yaml +2 -2
- data/openapi.json +11050 -1
- data/spec/api/analytics_api_spec.rb +87 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/models/api_version_spec.rb +30 -0
- data/spec/models/bookmark_group_response_spec.rb +32 -0
- data/spec/models/chunk_group_and_file_id_spec.rb +90 -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/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_setup_checkout_session_res_payload_spec.rb +36 -0
- data/spec/models/dataset_analytics_spec.rb +66 -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/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/granularity_spec.rb +30 -0
- data/spec/models/groups_bookmark_query_result_spec.rb +48 -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/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_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/spec_helper.rb +1 -1
- data/trieve_ruby_client.gemspec +1 -1
- metadata +456 -135
- 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
- data/trieve_ruby_client-0.8.2.gem +0 -0
- data/trieve_ruby_client-0.8.5.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
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Clear Dataset
|
23
|
-
#
|
23
|
+
# Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param dataset_id [String] The id of the dataset you want to clear.
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Clear Dataset
|
34
|
-
#
|
34
|
+
# Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param dataset_id [String] The id of the dataset you want to clear.
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -90,7 +90,7 @@ module TrieveRubyClient
|
|
90
90
|
end
|
91
91
|
|
92
92
|
# Create dataset
|
93
|
-
# Create
|
93
|
+
# Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
94
94
|
# @param tr_organization [String] The organization id to use for the request
|
95
95
|
# @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
|
96
96
|
# @param [Hash] opts the optional parameters
|
@@ -101,7 +101,7 @@ module TrieveRubyClient
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Create dataset
|
104
|
-
# Create
|
104
|
+
# Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
105
105
|
# @param tr_organization [String] The organization id to use for the request
|
106
106
|
# @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
|
107
107
|
# @param [Hash] opts the optional parameters
|
@@ -165,7 +165,7 @@ module TrieveRubyClient
|
|
165
165
|
end
|
166
166
|
|
167
167
|
# Delete Dataset
|
168
|
-
# Delete
|
168
|
+
# Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
169
169
|
# @param tr_dataset [String] The dataset id to use for the request
|
170
170
|
# @param dataset_id [String] The id of the dataset you want to delete.
|
171
171
|
# @param [Hash] opts the optional parameters
|
@@ -176,7 +176,7 @@ module TrieveRubyClient
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# Delete Dataset
|
179
|
-
# Delete
|
179
|
+
# Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
180
180
|
# @param tr_dataset [String] The dataset id to use for the request
|
181
181
|
# @param dataset_id [String] The id of the dataset you want to delete.
|
182
182
|
# @param [Hash] opts the optional parameters
|
@@ -235,7 +235,7 @@ module TrieveRubyClient
|
|
235
235
|
end
|
236
236
|
|
237
237
|
# Delete Dataset by Tracking ID
|
238
|
-
# Delete
|
238
|
+
# Delete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.
|
239
239
|
# @param tr_dataset [String] The dataset id to use for the request
|
240
240
|
# @param tracking_id [String] The tracking id of the dataset you want to delete.
|
241
241
|
# @param [Hash] opts the optional parameters
|
@@ -246,7 +246,7 @@ module TrieveRubyClient
|
|
246
246
|
end
|
247
247
|
|
248
248
|
# Delete Dataset by Tracking ID
|
249
|
-
# Delete
|
249
|
+
# Delete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.
|
250
250
|
# @param tr_dataset [String] The dataset id to use for the request
|
251
251
|
# @param tracking_id [String] The tracking id of the dataset you want to delete.
|
252
252
|
# @param [Hash] opts the optional parameters
|
@@ -304,72 +304,8 @@ module TrieveRubyClient
|
|
304
304
|
return data, status_code, headers
|
305
305
|
end
|
306
306
|
|
307
|
-
# Get Client Configuration
|
308
|
-
# Get Client Configuration Get the client configuration for a dataset. Will use the TR-D
|
309
|
-
# @param tr_dataset [String] The dataset id to use for the request
|
310
|
-
# @param [Hash] opts the optional parameters
|
311
|
-
# @return [ClientDatasetConfiguration]
|
312
|
-
def get_client_dataset_config(tr_dataset, opts = {})
|
313
|
-
data, _status_code, _headers = get_client_dataset_config_with_http_info(tr_dataset, opts)
|
314
|
-
data
|
315
|
-
end
|
316
|
-
|
317
|
-
# Get Client Configuration
|
318
|
-
# Get Client Configuration Get the client configuration for a dataset. Will use the TR-D
|
319
|
-
# @param tr_dataset [String] The dataset id to use for the request
|
320
|
-
# @param [Hash] opts the optional parameters
|
321
|
-
# @return [Array<(ClientDatasetConfiguration, Integer, Hash)>] ClientDatasetConfiguration data, response status code and response headers
|
322
|
-
def get_client_dataset_config_with_http_info(tr_dataset, opts = {})
|
323
|
-
if @api_client.config.debugging
|
324
|
-
@api_client.config.logger.debug 'Calling API: DatasetApi.get_client_dataset_config ...'
|
325
|
-
end
|
326
|
-
# verify the required parameter 'tr_dataset' is set
|
327
|
-
if @api_client.config.client_side_validation && tr_dataset.nil?
|
328
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_client_dataset_config"
|
329
|
-
end
|
330
|
-
# resource path
|
331
|
-
local_var_path = '/api/dataset/envs'
|
332
|
-
|
333
|
-
# query parameters
|
334
|
-
query_params = opts[:query_params] || {}
|
335
|
-
|
336
|
-
# header parameters
|
337
|
-
header_params = opts[:header_params] || {}
|
338
|
-
# HTTP header 'Accept' (if needed)
|
339
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
340
|
-
header_params[:'TR-Dataset'] = tr_dataset
|
341
|
-
|
342
|
-
# form parameters
|
343
|
-
form_params = opts[:form_params] || {}
|
344
|
-
|
345
|
-
# http body (model)
|
346
|
-
post_body = opts[:debug_body]
|
347
|
-
|
348
|
-
# return_type
|
349
|
-
return_type = opts[:debug_return_type] || 'ClientDatasetConfiguration'
|
350
|
-
|
351
|
-
# auth_names
|
352
|
-
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
353
|
-
|
354
|
-
new_options = opts.merge(
|
355
|
-
:operation => :"DatasetApi.get_client_dataset_config",
|
356
|
-
:header_params => header_params,
|
357
|
-
:query_params => query_params,
|
358
|
-
:form_params => form_params,
|
359
|
-
:body => post_body,
|
360
|
-
:auth_names => auth_names,
|
361
|
-
:return_type => return_type
|
362
|
-
)
|
363
|
-
|
364
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
365
|
-
if @api_client.config.debugging
|
366
|
-
@api_client.config.logger.debug "API called: DatasetApi#get_client_dataset_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
367
|
-
end
|
368
|
-
return data, status_code, headers
|
369
|
-
end
|
370
|
-
|
371
307
|
# Get Dataset
|
372
|
-
# Get
|
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.
|
373
309
|
# @param tr_dataset [String] The dataset id to use for the request
|
374
310
|
# @param dataset_id [String] The id of the dataset you want to retrieve.
|
375
311
|
# @param [Hash] opts the optional parameters
|
@@ -380,7 +316,7 @@ module TrieveRubyClient
|
|
380
316
|
end
|
381
317
|
|
382
318
|
# Get Dataset
|
383
|
-
# Get
|
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.
|
384
320
|
# @param tr_dataset [String] The dataset id to use for the request
|
385
321
|
# @param dataset_id [String] The id of the dataset you want to retrieve.
|
386
322
|
# @param [Hash] opts the optional parameters
|
@@ -439,7 +375,7 @@ module TrieveRubyClient
|
|
439
375
|
end
|
440
376
|
|
441
377
|
# Get Datasets from Organization
|
442
|
-
# 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.
|
443
379
|
# @param tr_organization [String] The organization id to use for the request
|
444
380
|
# @param organization_id [String] id of the organization you want to retrieve datasets for
|
445
381
|
# @param [Hash] opts the optional parameters
|
@@ -452,7 +388,7 @@ module TrieveRubyClient
|
|
452
388
|
end
|
453
389
|
|
454
390
|
# Get Datasets from Organization
|
455
|
-
# 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.
|
456
392
|
# @param tr_organization [String] The organization id to use for the request
|
457
393
|
# @param organization_id [String] id of the organization you want to retrieve datasets for
|
458
394
|
# @param [Hash] opts the optional parameters
|
@@ -515,7 +451,7 @@ module TrieveRubyClient
|
|
515
451
|
end
|
516
452
|
|
517
453
|
# Get Usage By Dataset ID
|
518
|
-
# Get
|
454
|
+
# Get the usage for a dataset by its id.
|
519
455
|
# @param tr_dataset [String] The dataset id to use for the request
|
520
456
|
# @param dataset_id [String] The id of the dataset you want to retrieve usage for.
|
521
457
|
# @param [Hash] opts the optional parameters
|
@@ -526,7 +462,7 @@ module TrieveRubyClient
|
|
526
462
|
end
|
527
463
|
|
528
464
|
# Get Usage By Dataset ID
|
529
|
-
# Get
|
465
|
+
# Get the usage for a dataset by its id.
|
530
466
|
# @param tr_dataset [String] The dataset id to use for the request
|
531
467
|
# @param dataset_id [String] The id of the dataset you want to retrieve usage for.
|
532
468
|
# @param [Hash] opts the optional parameters
|
@@ -585,7 +521,7 @@ module TrieveRubyClient
|
|
585
521
|
end
|
586
522
|
|
587
523
|
# Update Dataset
|
588
|
-
# Update
|
524
|
+
# Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
589
525
|
# @param tr_organization [String] The organization id to use for the request
|
590
526
|
# @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
|
591
527
|
# @param [Hash] opts the optional parameters
|
@@ -596,7 +532,7 @@ module TrieveRubyClient
|
|
596
532
|
end
|
597
533
|
|
598
534
|
# Update Dataset
|
599
|
-
# Update
|
535
|
+
# Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
600
536
|
# @param tr_organization [String] The organization id to use for the request
|
601
537
|
# @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
|
602
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,7 +240,7 @@ 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
245
|
# @param upload_file_req_payload [UploadFileReqPayload] JSON request payload to upload a file
|
246
246
|
# @param [Hash] opts the optional parameters
|
@@ -251,7 +251,7 @@ module TrieveRubyClient
|
|
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
256
|
# @param upload_file_req_payload [UploadFileReqPayload] JSON request payload to upload a file
|
257
257
|
# @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
|
# 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
|
@@ -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
|
# Create message
|
23
|
-
# Create message
|
23
|
+
# Create message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.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 create_message_req_payload [CreateMessageReqPayload] JSON request payload to create a message completion
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Create message
|
34
|
-
# Create message
|
34
|
+
# Create message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.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 create_message_req_payload [CreateMessageReqPayload] JSON request payload to create a message completion
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -95,7 +95,7 @@ module TrieveRubyClient
|
|
95
95
|
end
|
96
96
|
|
97
97
|
# Edit message
|
98
|
-
# Edit message
|
98
|
+
# Edit message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
99
99
|
# @param tr_dataset [String] The dataset id to use for the request
|
100
100
|
# @param edit_message_req_payload [EditMessageReqPayload] JSON request payload to edit a message and get a new stream
|
101
101
|
# @param [Hash] opts the optional parameters
|
@@ -106,7 +106,7 @@ module TrieveRubyClient
|
|
106
106
|
end
|
107
107
|
|
108
108
|
# Edit message
|
109
|
-
# Edit message
|
109
|
+
# Edit message which exists within the topic's chat history. This will delete the message and replace it with a new message. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
110
110
|
# @param tr_dataset [String] The dataset id to use for the request
|
111
111
|
# @param edit_message_req_payload [EditMessageReqPayload] JSON request payload to edit a message and get a new stream
|
112
112
|
# @param [Hash] opts the optional parameters
|
@@ -170,7 +170,7 @@ module TrieveRubyClient
|
|
170
170
|
end
|
171
171
|
|
172
172
|
# Get all messages for a given topic
|
173
|
-
# Get all messages for a given topic
|
173
|
+
# Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
174
174
|
# @param tr_dataset [String] The dataset id to use for the request
|
175
175
|
# @param messages_topic_id [String] The ID of the topic to get messages for.
|
176
176
|
# @param [Hash] opts the optional parameters
|
@@ -181,7 +181,7 @@ module TrieveRubyClient
|
|
181
181
|
end
|
182
182
|
|
183
183
|
# Get all messages for a given topic
|
184
|
-
# Get all messages for a given topic
|
184
|
+
# Get all messages for a given topic. If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information.
|
185
185
|
# @param tr_dataset [String] The dataset id to use for the request
|
186
186
|
# @param messages_topic_id [String] The ID of the topic to get messages for.
|
187
187
|
# @param [Hash] opts the optional parameters
|
@@ -240,7 +240,7 @@ module TrieveRubyClient
|
|
240
240
|
end
|
241
241
|
|
242
242
|
# Regenerate message
|
243
|
-
# Regenerate
|
243
|
+
# Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
244
244
|
# @param tr_dataset [String] The dataset id to use for the request
|
245
245
|
# @param regenerate_message_req_payload [RegenerateMessageReqPayload] JSON request payload to delete an agent message then regenerate it in a strem
|
246
246
|
# @param [Hash] opts the optional parameters
|
@@ -251,7 +251,7 @@ module TrieveRubyClient
|
|
251
251
|
end
|
252
252
|
|
253
253
|
# Regenerate message
|
254
|
-
# Regenerate
|
254
|
+
# Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
255
255
|
# @param tr_dataset [String] The dataset id to use for the request
|
256
256
|
# @param regenerate_message_req_payload [RegenerateMessageReqPayload] JSON request payload to delete an agent message then regenerate it in a strem
|
257
257
|
# @param [Hash] opts the optional parameters
|
@@ -0,0 +1,79 @@
|
|
1
|
+
=begin
|
2
|
+
#Trieve API
|
3
|
+
|
4
|
+
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
|
+
Contact: developers@trieve.ai
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module TrieveRubyClient
|
16
|
+
class MetricsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get Prometheus Metrics
|
23
|
+
# This route allows you to view the number of items in each queue in the Prometheus format.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [String]
|
26
|
+
def get_metrics(opts = {})
|
27
|
+
data, _status_code, _headers = get_metrics_with_http_info(opts)
|
28
|
+
data
|
29
|
+
end
|
30
|
+
|
31
|
+
# Get Prometheus Metrics
|
32
|
+
# This route allows you to view the number of items in each queue in the Prometheus format.
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
35
|
+
def get_metrics_with_http_info(opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: MetricsApi.get_metrics ...'
|
38
|
+
end
|
39
|
+
# resource path
|
40
|
+
local_var_path = '/metrics'
|
41
|
+
|
42
|
+
# query parameters
|
43
|
+
query_params = opts[:query_params] || {}
|
44
|
+
|
45
|
+
# header parameters
|
46
|
+
header_params = opts[:header_params] || {}
|
47
|
+
# HTTP header 'Accept' (if needed)
|
48
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json'])
|
49
|
+
|
50
|
+
# form parameters
|
51
|
+
form_params = opts[:form_params] || {}
|
52
|
+
|
53
|
+
# http body (model)
|
54
|
+
post_body = opts[:debug_body]
|
55
|
+
|
56
|
+
# return_type
|
57
|
+
return_type = opts[:debug_return_type] || 'String'
|
58
|
+
|
59
|
+
# auth_names
|
60
|
+
auth_names = opts[:debug_auth_names] || ['X-API-KEY']
|
61
|
+
|
62
|
+
new_options = opts.merge(
|
63
|
+
:operation => :"MetricsApi.get_metrics",
|
64
|
+
:header_params => header_params,
|
65
|
+
:query_params => query_params,
|
66
|
+
:form_params => form_params,
|
67
|
+
:body => post_body,
|
68
|
+
:auth_names => auth_names,
|
69
|
+
:return_type => return_type
|
70
|
+
)
|
71
|
+
|
72
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
73
|
+
if @api_client.config.debugging
|
74
|
+
@api_client.config.logger.debug "API called: MetricsApi#get_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
|
+
end
|
76
|
+
return data, status_code, headers
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
@@ -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
|
# Create Organization
|
23
|
-
# Create
|
23
|
+
# Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
|
24
24
|
# @param create_organization_data [CreateOrganizationData] The organization data that you want to create
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [Organization]
|
@@ -30,7 +30,7 @@ module TrieveRubyClient
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Create Organization
|
33
|
-
# Create
|
33
|
+
# Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
|
34
34
|
# @param create_organization_data [CreateOrganizationData] The organization data that you want to create
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
@@ -88,7 +88,7 @@ module TrieveRubyClient
|
|
88
88
|
end
|
89
89
|
|
90
90
|
# Delete Organization
|
91
|
-
# Delete
|
91
|
+
# Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
|
92
92
|
# @param tr_organization [String] The organization id to use for the request
|
93
93
|
# @param organization_id [String] The id of the organization you want to fetch.
|
94
94
|
# @param [Hash] opts the optional parameters
|
@@ -99,7 +99,7 @@ module TrieveRubyClient
|
|
99
99
|
end
|
100
100
|
|
101
101
|
# Delete Organization
|
102
|
-
# Delete
|
102
|
+
# Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
|
103
103
|
# @param tr_organization [String] The organization id to use for the request
|
104
104
|
# @param organization_id [String] The id of the organization you want to fetch.
|
105
105
|
# @param [Hash] opts the optional parameters
|
@@ -158,7 +158,7 @@ module TrieveRubyClient
|
|
158
158
|
end
|
159
159
|
|
160
160
|
# Get Organization
|
161
|
-
#
|
161
|
+
# Fetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
162
162
|
# @param tr_organization [String] The organization id to use for the request
|
163
163
|
# @param organization_id [String] The id of the organization you want to fetch.
|
164
164
|
# @param [Hash] opts the optional parameters
|
@@ -169,7 +169,7 @@ module TrieveRubyClient
|
|
169
169
|
end
|
170
170
|
|
171
171
|
# Get Organization
|
172
|
-
#
|
172
|
+
# Fetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
173
173
|
# @param tr_organization [String] The organization id to use for the request
|
174
174
|
# @param organization_id [String] The id of the organization you want to fetch.
|
175
175
|
# @param [Hash] opts the optional parameters
|
@@ -228,7 +228,7 @@ module TrieveRubyClient
|
|
228
228
|
end
|
229
229
|
|
230
230
|
# Get Organization Usage
|
231
|
-
#
|
231
|
+
# Fetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
232
232
|
# @param tr_organization [String] The organization id to use for the request
|
233
233
|
# @param organization_id [String] The id of the organization you want to fetch the usage of.
|
234
234
|
# @param [Hash] opts the optional parameters
|
@@ -239,7 +239,7 @@ module TrieveRubyClient
|
|
239
239
|
end
|
240
240
|
|
241
241
|
# Get Organization Usage
|
242
|
-
#
|
242
|
+
# Fetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
243
243
|
# @param tr_organization [String] The organization id to use for the request
|
244
244
|
# @param organization_id [String] The id of the organization you want to fetch the usage of.
|
245
245
|
# @param [Hash] opts the optional parameters
|
@@ -298,7 +298,7 @@ module TrieveRubyClient
|
|
298
298
|
end
|
299
299
|
|
300
300
|
# Get Organization Users
|
301
|
-
#
|
301
|
+
# Fetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
302
302
|
# @param tr_organization [String] The organization id to use for the request
|
303
303
|
# @param organization_id [String] The id of the organization you want to fetch the users of.
|
304
304
|
# @param [Hash] opts the optional parameters
|
@@ -309,7 +309,7 @@ module TrieveRubyClient
|
|
309
309
|
end
|
310
310
|
|
311
311
|
# Get Organization Users
|
312
|
-
#
|
312
|
+
# Fetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
313
313
|
# @param tr_organization [String] The organization id to use for the request
|
314
314
|
# @param organization_id [String] The id of the organization you want to fetch the users of.
|
315
315
|
# @param [Hash] opts the optional parameters
|
@@ -368,7 +368,7 @@ module TrieveRubyClient
|
|
368
368
|
end
|
369
369
|
|
370
370
|
# Update Organization
|
371
|
-
# Update
|
371
|
+
# Update an organization. Only the owner of the organization can update it.
|
372
372
|
# @param tr_organization [String] The organization id to use for the request
|
373
373
|
# @param update_organization_data [UpdateOrganizationData] The organization data that you want to update
|
374
374
|
# @param [Hash] opts the optional parameters
|
@@ -379,7 +379,7 @@ module TrieveRubyClient
|
|
379
379
|
end
|
380
380
|
|
381
381
|
# Update Organization
|
382
|
-
# Update
|
382
|
+
# Update an organization. Only the owner of the organization can update it.
|
383
383
|
# @param tr_organization [String] The organization id to use for the request
|
384
384
|
# @param update_organization_data [UpdateOrganizationData] The organization data that you want to update
|
385
385
|
# @param [Hash] opts the optional parameters
|