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,34 +19,34 @@ module TrieveRubyClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Create
|
23
|
-
# Create
|
22
|
+
# 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
|
-
# @param
|
25
|
+
# @param create_message_req_payload [CreateMessageReqPayload] JSON request payload to create a message completion
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [String]
|
28
|
-
def
|
29
|
-
data, _status_code, _headers =
|
28
|
+
def create_message(tr_dataset, create_message_req_payload, opts = {})
|
29
|
+
data, _status_code, _headers = create_message_with_http_info(tr_dataset, create_message_req_payload, opts)
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
|
-
# Create
|
34
|
-
# Create
|
33
|
+
# 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
|
-
# @param
|
36
|
+
# @param create_message_req_payload [CreateMessageReqPayload] JSON request payload to create a message completion
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
39
|
-
def
|
39
|
+
def create_message_with_http_info(tr_dataset, create_message_req_payload, opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
|
-
@api_client.config.logger.debug 'Calling API: MessageApi.
|
41
|
+
@api_client.config.logger.debug 'Calling API: MessageApi.create_message ...'
|
42
42
|
end
|
43
43
|
# verify the required parameter 'tr_dataset' is set
|
44
44
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
45
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling MessageApi.
|
45
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling MessageApi.create_message"
|
46
46
|
end
|
47
|
-
# verify the required parameter '
|
48
|
-
if @api_client.config.client_side_validation &&
|
49
|
-
fail ArgumentError, "Missing the required parameter '
|
47
|
+
# verify the required parameter 'create_message_req_payload' is set
|
48
|
+
if @api_client.config.client_side_validation && create_message_req_payload.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'create_message_req_payload' when calling MessageApi.create_message"
|
50
50
|
end
|
51
51
|
# resource path
|
52
52
|
local_var_path = '/api/message'
|
@@ -69,7 +69,7 @@ module TrieveRubyClient
|
|
69
69
|
form_params = opts[:form_params] || {}
|
70
70
|
|
71
71
|
# http body (model)
|
72
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
72
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_message_req_payload)
|
73
73
|
|
74
74
|
# return_type
|
75
75
|
return_type = opts[:debug_return_type] || 'String'
|
@@ -78,7 +78,7 @@ module TrieveRubyClient
|
|
78
78
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
79
79
|
|
80
80
|
new_options = opts.merge(
|
81
|
-
:operation => :"MessageApi.
|
81
|
+
:operation => :"MessageApi.create_message",
|
82
82
|
:header_params => header_params,
|
83
83
|
:query_params => query_params,
|
84
84
|
:form_params => form_params,
|
@@ -89,39 +89,39 @@ module TrieveRubyClient
|
|
89
89
|
|
90
90
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
91
91
|
if @api_client.config.debugging
|
92
|
-
@api_client.config.logger.debug "API called: MessageApi#
|
92
|
+
@api_client.config.logger.debug "API called: MessageApi#create_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
93
|
end
|
94
94
|
return data, status_code, headers
|
95
95
|
end
|
96
96
|
|
97
|
-
# Edit
|
98
|
-
# Edit
|
97
|
+
# 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
|
-
# @param
|
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
|
102
102
|
# @return [nil]
|
103
|
-
def
|
104
|
-
|
103
|
+
def edit_message(tr_dataset, edit_message_req_payload, opts = {})
|
104
|
+
edit_message_with_http_info(tr_dataset, edit_message_req_payload, opts)
|
105
105
|
nil
|
106
106
|
end
|
107
107
|
|
108
|
-
# Edit
|
109
|
-
# Edit
|
108
|
+
# 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
|
-
# @param
|
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
|
113
113
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
114
|
-
def
|
114
|
+
def edit_message_with_http_info(tr_dataset, edit_message_req_payload, opts = {})
|
115
115
|
if @api_client.config.debugging
|
116
|
-
@api_client.config.logger.debug 'Calling API: MessageApi.
|
116
|
+
@api_client.config.logger.debug 'Calling API: MessageApi.edit_message ...'
|
117
117
|
end
|
118
118
|
# verify the required parameter 'tr_dataset' is set
|
119
119
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
120
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling MessageApi.
|
120
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling MessageApi.edit_message"
|
121
121
|
end
|
122
|
-
# verify the required parameter '
|
123
|
-
if @api_client.config.client_side_validation &&
|
124
|
-
fail ArgumentError, "Missing the required parameter '
|
122
|
+
# verify the required parameter 'edit_message_req_payload' is set
|
123
|
+
if @api_client.config.client_side_validation && edit_message_req_payload.nil?
|
124
|
+
fail ArgumentError, "Missing the required parameter 'edit_message_req_payload' when calling MessageApi.edit_message"
|
125
125
|
end
|
126
126
|
# resource path
|
127
127
|
local_var_path = '/api/message'
|
@@ -144,7 +144,7 @@ module TrieveRubyClient
|
|
144
144
|
form_params = opts[:form_params] || {}
|
145
145
|
|
146
146
|
# http body (model)
|
147
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
147
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(edit_message_req_payload)
|
148
148
|
|
149
149
|
# return_type
|
150
150
|
return_type = opts[:debug_return_type]
|
@@ -153,7 +153,7 @@ module TrieveRubyClient
|
|
153
153
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
154
154
|
|
155
155
|
new_options = opts.merge(
|
156
|
-
:operation => :"MessageApi.
|
156
|
+
:operation => :"MessageApi.edit_message",
|
157
157
|
:header_params => header_params,
|
158
158
|
:query_params => query_params,
|
159
159
|
:form_params => form_params,
|
@@ -164,13 +164,13 @@ module TrieveRubyClient
|
|
164
164
|
|
165
165
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
166
166
|
if @api_client.config.debugging
|
167
|
-
@api_client.config.logger.debug "API called: MessageApi#
|
167
|
+
@api_client.config.logger.debug "API called: MessageApi#edit_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
168
168
|
end
|
169
169
|
return data, status_code, headers
|
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,33 +240,33 @@ 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
|
-
# @param
|
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
|
247
247
|
# @return [String]
|
248
|
-
def
|
249
|
-
data, _status_code, _headers =
|
248
|
+
def regenerate_message(tr_dataset, regenerate_message_req_payload, opts = {})
|
249
|
+
data, _status_code, _headers = regenerate_message_with_http_info(tr_dataset, regenerate_message_req_payload, opts)
|
250
250
|
data
|
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
|
-
# @param
|
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
|
258
258
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
259
|
-
def
|
259
|
+
def regenerate_message_with_http_info(tr_dataset, regenerate_message_req_payload, opts = {})
|
260
260
|
if @api_client.config.debugging
|
261
|
-
@api_client.config.logger.debug 'Calling API: MessageApi.
|
261
|
+
@api_client.config.logger.debug 'Calling API: MessageApi.regenerate_message ...'
|
262
262
|
end
|
263
263
|
# verify the required parameter 'tr_dataset' is set
|
264
264
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
265
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling MessageApi.
|
265
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling MessageApi.regenerate_message"
|
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 'regenerate_message_req_payload' is set
|
268
|
+
if @api_client.config.client_side_validation && regenerate_message_req_payload.nil?
|
269
|
+
fail ArgumentError, "Missing the required parameter 'regenerate_message_req_payload' when calling MessageApi.regenerate_message"
|
270
270
|
end
|
271
271
|
# resource path
|
272
272
|
local_var_path = '/api/message'
|
@@ -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(regenerate_message_req_payload)
|
293
293
|
|
294
294
|
# return_type
|
295
295
|
return_type = opts[:debug_return_type] || 'String'
|
@@ -298,7 +298,7 @@ module TrieveRubyClient
|
|
298
298
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
299
299
|
|
300
300
|
new_options = opts.merge(
|
301
|
-
:operation => :"MessageApi.
|
301
|
+
:operation => :"MessageApi.regenerate_message",
|
302
302
|
:header_params => header_params,
|
303
303
|
:query_params => query_params,
|
304
304
|
:form_params => form_params,
|
@@ -309,7 +309,7 @@ module TrieveRubyClient
|
|
309
309
|
|
310
310
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
311
311
|
if @api_client.config.debugging
|
312
|
-
@api_client.config.logger.debug "API called: MessageApi#
|
312
|
+
@api_client.config.logger.debug "API called: MessageApi#regenerate_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
313
313
|
end
|
314
314
|
return data, status_code, headers
|
315
315
|
end
|
@@ -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,33 +88,33 @@ 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
|
95
|
-
# @return [
|
96
|
-
def
|
97
|
-
|
98
|
-
|
95
|
+
# @return [nil]
|
96
|
+
def delete_organization(tr_organization, organization_id, opts = {})
|
97
|
+
delete_organization_with_http_info(tr_organization, organization_id, opts)
|
98
|
+
nil
|
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
|
106
|
-
# @return [Array<(
|
107
|
-
def
|
106
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
107
|
+
def delete_organization_with_http_info(tr_organization, organization_id, opts = {})
|
108
108
|
if @api_client.config.debugging
|
109
|
-
@api_client.config.logger.debug 'Calling API: OrganizationApi.
|
109
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.delete_organization ...'
|
110
110
|
end
|
111
111
|
# verify the required parameter 'tr_organization' is set
|
112
112
|
if @api_client.config.client_side_validation && tr_organization.nil?
|
113
|
-
fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.
|
113
|
+
fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.delete_organization"
|
114
114
|
end
|
115
115
|
# verify the required parameter 'organization_id' is set
|
116
116
|
if @api_client.config.client_side_validation && organization_id.nil?
|
117
|
-
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.
|
117
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.delete_organization"
|
118
118
|
end
|
119
119
|
# resource path
|
120
120
|
local_var_path = '/api/organization/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))
|
@@ -135,13 +135,13 @@ module TrieveRubyClient
|
|
135
135
|
post_body = opts[:debug_body]
|
136
136
|
|
137
137
|
# return_type
|
138
|
-
return_type = opts[:debug_return_type]
|
138
|
+
return_type = opts[:debug_return_type]
|
139
139
|
|
140
140
|
# auth_names
|
141
141
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
142
142
|
|
143
143
|
new_options = opts.merge(
|
144
|
-
:operation => :"OrganizationApi.
|
144
|
+
:operation => :"OrganizationApi.delete_organization",
|
145
145
|
:header_params => header_params,
|
146
146
|
:query_params => query_params,
|
147
147
|
:form_params => form_params,
|
@@ -152,39 +152,39 @@ module TrieveRubyClient
|
|
152
152
|
|
153
153
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
154
154
|
if @api_client.config.debugging
|
155
|
-
@api_client.config.logger.debug "API called: OrganizationApi#
|
155
|
+
@api_client.config.logger.debug "API called: OrganizationApi#delete_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
156
156
|
end
|
157
157
|
return data, status_code, headers
|
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
|
165
165
|
# @return [Organization]
|
166
|
-
def
|
167
|
-
data, _status_code, _headers =
|
166
|
+
def get_organization(tr_organization, organization_id, opts = {})
|
167
|
+
data, _status_code, _headers = get_organization_with_http_info(tr_organization, organization_id, opts)
|
168
168
|
data
|
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
|
176
176
|
# @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
|
177
|
-
def
|
177
|
+
def get_organization_with_http_info(tr_organization, organization_id, opts = {})
|
178
178
|
if @api_client.config.debugging
|
179
|
-
@api_client.config.logger.debug 'Calling API: OrganizationApi.
|
179
|
+
@api_client.config.logger.debug 'Calling API: OrganizationApi.get_organization ...'
|
180
180
|
end
|
181
181
|
# verify the required parameter 'tr_organization' is set
|
182
182
|
if @api_client.config.client_side_validation && tr_organization.nil?
|
183
|
-
fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.
|
183
|
+
fail ArgumentError, "Missing the required parameter 'tr_organization' when calling OrganizationApi.get_organization"
|
184
184
|
end
|
185
185
|
# verify the required parameter 'organization_id' is set
|
186
186
|
if @api_client.config.client_side_validation && organization_id.nil?
|
187
|
-
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.
|
187
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationApi.get_organization"
|
188
188
|
end
|
189
189
|
# resource path
|
190
190
|
local_var_path = '/api/organization/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))
|
@@ -211,7 +211,7 @@ module TrieveRubyClient
|
|
211
211
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
212
212
|
|
213
213
|
new_options = opts.merge(
|
214
|
-
:operation => :"OrganizationApi.
|
214
|
+
:operation => :"OrganizationApi.get_organization",
|
215
215
|
:header_params => header_params,
|
216
216
|
:query_params => query_params,
|
217
217
|
:form_params => form_params,
|
@@ -222,13 +222,13 @@ module TrieveRubyClient
|
|
222
222
|
|
223
223
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
224
224
|
if @api_client.config.debugging
|
225
|
-
@api_client.config.logger.debug "API called: OrganizationApi#
|
225
|
+
@api_client.config.logger.debug "API called: OrganizationApi#get_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
226
226
|
end
|
227
227
|
return data, status_code, headers
|
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
|