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
data/docs/MessageApi.md
CHANGED
@@ -4,19 +4,19 @@ All URIs are relative to *https://api.trieve.ai*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**create_message**](MessageApi.md#create_message) | **POST** /api/message | Create message |
|
8
|
+
| [**edit_message**](MessageApi.md#edit_message) | **PUT** /api/message | Edit message |
|
9
9
|
| [**get_all_topic_messages**](MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic |
|
10
|
-
| [**
|
10
|
+
| [**regenerate_message**](MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message |
|
11
11
|
|
12
12
|
|
13
|
-
##
|
13
|
+
## create_message
|
14
14
|
|
15
|
-
> String
|
15
|
+
> String create_message(tr_dataset, create_message_req_payload)
|
16
16
|
|
17
|
-
Create
|
17
|
+
Create message
|
18
18
|
|
19
|
-
Create
|
19
|
+
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.
|
20
20
|
|
21
21
|
### Examples
|
22
22
|
|
@@ -33,32 +33,32 @@ end
|
|
33
33
|
|
34
34
|
api_instance = TrieveRubyClient::MessageApi.new
|
35
35
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
36
|
-
|
36
|
+
create_message_req_payload = TrieveRubyClient::CreateMessageReqPayload.new({new_message_content: 'new_message_content_example', topic_id: 'topic_id_example'}) # CreateMessageReqPayload | JSON request payload to create a message completion
|
37
37
|
|
38
38
|
begin
|
39
|
-
# Create
|
40
|
-
result = api_instance.
|
39
|
+
# Create message
|
40
|
+
result = api_instance.create_message(tr_dataset, create_message_req_payload)
|
41
41
|
p result
|
42
42
|
rescue TrieveRubyClient::ApiError => e
|
43
|
-
puts "Error when calling MessageApi->
|
43
|
+
puts "Error when calling MessageApi->create_message: #{e}"
|
44
44
|
end
|
45
45
|
```
|
46
46
|
|
47
|
-
#### Using the
|
47
|
+
#### Using the create_message_with_http_info variant
|
48
48
|
|
49
49
|
This returns an Array which contains the response data, status code and headers.
|
50
50
|
|
51
|
-
> <Array(String, Integer, Hash)>
|
51
|
+
> <Array(String, Integer, Hash)> create_message_with_http_info(tr_dataset, create_message_req_payload)
|
52
52
|
|
53
53
|
```ruby
|
54
54
|
begin
|
55
|
-
# Create
|
56
|
-
data, status_code, headers = api_instance.
|
55
|
+
# Create message
|
56
|
+
data, status_code, headers = api_instance.create_message_with_http_info(tr_dataset, create_message_req_payload)
|
57
57
|
p status_code # => 2xx
|
58
58
|
p headers # => { ... }
|
59
59
|
p data # => String
|
60
60
|
rescue TrieveRubyClient::ApiError => e
|
61
|
-
puts "Error when calling MessageApi->
|
61
|
+
puts "Error when calling MessageApi->create_message_with_http_info: #{e}"
|
62
62
|
end
|
63
63
|
```
|
64
64
|
|
@@ -67,7 +67,7 @@ end
|
|
67
67
|
| Name | Type | Description | Notes |
|
68
68
|
| ---- | ---- | ----------- | ----- |
|
69
69
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
70
|
-
| **
|
70
|
+
| **create_message_req_payload** | [**CreateMessageReqPayload**](CreateMessageReqPayload.md) | JSON request payload to create a message completion | |
|
71
71
|
|
72
72
|
### Return type
|
73
73
|
|
@@ -83,13 +83,13 @@ end
|
|
83
83
|
- **Accept**: text/plain, application/json
|
84
84
|
|
85
85
|
|
86
|
-
##
|
86
|
+
## edit_message
|
87
87
|
|
88
|
-
>
|
88
|
+
> edit_message(tr_dataset, edit_message_req_payload)
|
89
89
|
|
90
|
-
Edit
|
90
|
+
Edit message
|
91
91
|
|
92
|
-
Edit
|
92
|
+
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.
|
93
93
|
|
94
94
|
### Examples
|
95
95
|
|
@@ -106,31 +106,31 @@ end
|
|
106
106
|
|
107
107
|
api_instance = TrieveRubyClient::MessageApi.new
|
108
108
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
109
|
-
|
109
|
+
edit_message_req_payload = TrieveRubyClient::EditMessageReqPayload.new({message_sort_order: 37, new_message_content: 'new_message_content_example', topic_id: 'topic_id_example'}) # EditMessageReqPayload | JSON request payload to edit a message and get a new stream
|
110
110
|
|
111
111
|
begin
|
112
|
-
# Edit
|
113
|
-
api_instance.
|
112
|
+
# Edit message
|
113
|
+
api_instance.edit_message(tr_dataset, edit_message_req_payload)
|
114
114
|
rescue TrieveRubyClient::ApiError => e
|
115
|
-
puts "Error when calling MessageApi->
|
115
|
+
puts "Error when calling MessageApi->edit_message: #{e}"
|
116
116
|
end
|
117
117
|
```
|
118
118
|
|
119
|
-
#### Using the
|
119
|
+
#### Using the edit_message_with_http_info variant
|
120
120
|
|
121
121
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
122
122
|
|
123
|
-
> <Array(nil, Integer, Hash)>
|
123
|
+
> <Array(nil, Integer, Hash)> edit_message_with_http_info(tr_dataset, edit_message_req_payload)
|
124
124
|
|
125
125
|
```ruby
|
126
126
|
begin
|
127
|
-
# Edit
|
128
|
-
data, status_code, headers = api_instance.
|
127
|
+
# Edit message
|
128
|
+
data, status_code, headers = api_instance.edit_message_with_http_info(tr_dataset, edit_message_req_payload)
|
129
129
|
p status_code # => 2xx
|
130
130
|
p headers # => { ... }
|
131
131
|
p data # => nil
|
132
132
|
rescue TrieveRubyClient::ApiError => e
|
133
|
-
puts "Error when calling MessageApi->
|
133
|
+
puts "Error when calling MessageApi->edit_message_with_http_info: #{e}"
|
134
134
|
end
|
135
135
|
```
|
136
136
|
|
@@ -139,7 +139,7 @@ end
|
|
139
139
|
| Name | Type | Description | Notes |
|
140
140
|
| ---- | ---- | ----------- | ----- |
|
141
141
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
142
|
-
| **
|
142
|
+
| **edit_message_req_payload** | [**EditMessageReqPayload**](EditMessageReqPayload.md) | JSON request payload to edit a message and get a new stream | |
|
143
143
|
|
144
144
|
### Return type
|
145
145
|
|
@@ -161,7 +161,7 @@ nil (empty response body)
|
|
161
161
|
|
162
162
|
Get all messages for a given topic
|
163
163
|
|
164
|
-
Get all messages for a given topic
|
164
|
+
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.
|
165
165
|
|
166
166
|
### Examples
|
167
167
|
|
@@ -228,13 +228,13 @@ end
|
|
228
228
|
- **Accept**: application/json
|
229
229
|
|
230
230
|
|
231
|
-
##
|
231
|
+
## regenerate_message
|
232
232
|
|
233
|
-
> String
|
233
|
+
> String regenerate_message(tr_dataset, regenerate_message_req_payload)
|
234
234
|
|
235
235
|
Regenerate message
|
236
236
|
|
237
|
-
Regenerate
|
237
|
+
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.
|
238
238
|
|
239
239
|
### Examples
|
240
240
|
|
@@ -251,32 +251,32 @@ end
|
|
251
251
|
|
252
252
|
api_instance = TrieveRubyClient::MessageApi.new
|
253
253
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
254
|
-
|
254
|
+
regenerate_message_req_payload = TrieveRubyClient::RegenerateMessageReqPayload.new({topic_id: 'topic_id_example'}) # RegenerateMessageReqPayload | JSON request payload to delete an agent message then regenerate it in a strem
|
255
255
|
|
256
256
|
begin
|
257
257
|
# Regenerate message
|
258
|
-
result = api_instance.
|
258
|
+
result = api_instance.regenerate_message(tr_dataset, regenerate_message_req_payload)
|
259
259
|
p result
|
260
260
|
rescue TrieveRubyClient::ApiError => e
|
261
|
-
puts "Error when calling MessageApi->
|
261
|
+
puts "Error when calling MessageApi->regenerate_message: #{e}"
|
262
262
|
end
|
263
263
|
```
|
264
264
|
|
265
|
-
#### Using the
|
265
|
+
#### Using the regenerate_message_with_http_info variant
|
266
266
|
|
267
267
|
This returns an Array which contains the response data, status code and headers.
|
268
268
|
|
269
|
-
> <Array(String, Integer, Hash)>
|
269
|
+
> <Array(String, Integer, Hash)> regenerate_message_with_http_info(tr_dataset, regenerate_message_req_payload)
|
270
270
|
|
271
271
|
```ruby
|
272
272
|
begin
|
273
273
|
# Regenerate message
|
274
|
-
data, status_code, headers = api_instance.
|
274
|
+
data, status_code, headers = api_instance.regenerate_message_with_http_info(tr_dataset, regenerate_message_req_payload)
|
275
275
|
p status_code # => 2xx
|
276
276
|
p headers # => { ... }
|
277
277
|
p data # => String
|
278
278
|
rescue TrieveRubyClient::ApiError => e
|
279
|
-
puts "Error when calling MessageApi->
|
279
|
+
puts "Error when calling MessageApi->regenerate_message_with_http_info: #{e}"
|
280
280
|
end
|
281
281
|
```
|
282
282
|
|
@@ -285,7 +285,7 @@ end
|
|
285
285
|
| Name | Type | Description | Notes |
|
286
286
|
| ---- | ---- | ----------- | ----- |
|
287
287
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
288
|
-
| **
|
288
|
+
| **regenerate_message_req_payload** | [**RegenerateMessageReqPayload**](RegenerateMessageReqPayload.md) | JSON request payload to delete an agent message then regenerate it in a strem | |
|
289
289
|
|
290
290
|
### Return type
|
291
291
|
|
data/docs/MetricsApi.md
ADDED
@@ -0,0 +1,76 @@
|
|
1
|
+
# TrieveRubyClient::MetricsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.trieve.ai*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_metrics**](MetricsApi.md#get_metrics) | **POST** /metrics | Get Prometheus Metrics |
|
8
|
+
|
9
|
+
|
10
|
+
## get_metrics
|
11
|
+
|
12
|
+
> String get_metrics
|
13
|
+
|
14
|
+
Get Prometheus Metrics
|
15
|
+
|
16
|
+
This route allows you to view the number of items in each queue in the Prometheus format.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'trieve_ruby_client'
|
23
|
+
# setup authorization
|
24
|
+
TrieveRubyClient.configure do |config|
|
25
|
+
# Configure API key authorization: X-API-KEY
|
26
|
+
config.api_key['X-API-KEY'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['X-API-KEY'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = TrieveRubyClient::MetricsApi.new
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Get Prometheus Metrics
|
35
|
+
result = api_instance.get_metrics
|
36
|
+
p result
|
37
|
+
rescue TrieveRubyClient::ApiError => e
|
38
|
+
puts "Error when calling MetricsApi->get_metrics: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the get_metrics_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(String, Integer, Hash)> get_metrics_with_http_info
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Get Prometheus Metrics
|
51
|
+
data, status_code, headers = api_instance.get_metrics_with_http_info
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => String
|
55
|
+
rescue TrieveRubyClient::ApiError => e
|
56
|
+
puts "Error when calling MetricsApi->get_metrics_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
This endpoint does not need any parameter.
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
**String**
|
67
|
+
|
68
|
+
### Authorization
|
69
|
+
|
70
|
+
[X-API-KEY](../README.md#X-API-KEY)
|
71
|
+
|
72
|
+
### HTTP request headers
|
73
|
+
|
74
|
+
- **Content-Type**: Not defined
|
75
|
+
- **Accept**: text/plain, application/json
|
76
|
+
|
@@ -0,0 +1,51 @@
|
|
1
|
+
# TrieveRubyClient::NewChunkMetadataTypes
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
TrieveRubyClient::NewChunkMetadataTypes.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'ChunkMetadata',
|
18
|
+
# :'ContentChunkMetadata',
|
19
|
+
# :'SlimChunkMetadataWithArrayTagSet'
|
20
|
+
# ]
|
21
|
+
```
|
22
|
+
|
23
|
+
### build
|
24
|
+
|
25
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
26
|
+
|
27
|
+
#### Example
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
require 'trieve_ruby_client'
|
31
|
+
|
32
|
+
TrieveRubyClient::NewChunkMetadataTypes.build(data)
|
33
|
+
# => #<ChunkMetadata:0x00007fdd4aab02a0>
|
34
|
+
|
35
|
+
TrieveRubyClient::NewChunkMetadataTypes.build(data_that_doesnt_match)
|
36
|
+
# => nil
|
37
|
+
```
|
38
|
+
|
39
|
+
#### Parameters
|
40
|
+
|
41
|
+
| Name | Type | Description |
|
42
|
+
| ---- | ---- | ----------- |
|
43
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
44
|
+
|
45
|
+
#### Return type
|
46
|
+
|
47
|
+
- `ChunkMetadata`
|
48
|
+
- `ContentChunkMetadata`
|
49
|
+
- `SlimChunkMetadataWithArrayTagSet`
|
50
|
+
- `nil` (if no type matches)
|
51
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TrieveRubyClient::NoResultQueries
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **filter** | [**SearchAnalyticsFilter**](SearchAnalyticsFilter.md) | | [optional] |
|
8
|
+
| **page** | **Integer** | | [optional] |
|
9
|
+
| **type** | **String** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trieve_ruby_client'
|
15
|
+
|
16
|
+
instance = TrieveRubyClient::NoResultQueries.new(
|
17
|
+
filter: null,
|
18
|
+
page: null,
|
19
|
+
type: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Organization.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **created_at** | **Time** | | |
|
8
|
+
| **deleted** | **Integer** | | |
|
8
9
|
| **id** | **String** | | |
|
9
10
|
| **name** | **String** | | |
|
10
11
|
| **registerable** | **Boolean** | | [optional] |
|
@@ -17,6 +18,7 @@ require 'trieve_ruby_client'
|
|
17
18
|
|
18
19
|
instance = TrieveRubyClient::Organization.new(
|
19
20
|
created_at: null,
|
21
|
+
deleted: null,
|
20
22
|
id: null,
|
21
23
|
name: null,
|
22
24
|
registerable: null,
|
data/docs/OrganizationApi.md
CHANGED
@@ -5,8 +5,8 @@ All URIs are relative to *https://api.trieve.ai*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_organization**](OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization |
|
8
|
-
| [**
|
9
|
-
| [**
|
8
|
+
| [**delete_organization**](OrganizationApi.md#delete_organization) | **DELETE** /api/organization/{organization_id} | Delete Organization |
|
9
|
+
| [**get_organization**](OrganizationApi.md#get_organization) | **GET** /api/organization/{organization_id} | Get Organization |
|
10
10
|
| [**get_organization_usage**](OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage |
|
11
11
|
| [**get_organization_users**](OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users |
|
12
12
|
| [**update_organization**](OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization |
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://api.trieve.ai*
|
|
18
18
|
|
19
19
|
Create Organization
|
20
20
|
|
21
|
-
Create
|
21
|
+
Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization.
|
22
22
|
|
23
23
|
### Examples
|
24
24
|
|
@@ -83,13 +83,13 @@ end
|
|
83
83
|
- **Accept**: application/json
|
84
84
|
|
85
85
|
|
86
|
-
##
|
86
|
+
## delete_organization
|
87
87
|
|
88
|
-
>
|
88
|
+
> delete_organization(tr_organization, organization_id)
|
89
89
|
|
90
90
|
Delete Organization
|
91
91
|
|
92
|
-
Delete
|
92
|
+
Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it.
|
93
93
|
|
94
94
|
### Examples
|
95
95
|
|
@@ -110,28 +110,27 @@ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of th
|
|
110
110
|
|
111
111
|
begin
|
112
112
|
# Delete Organization
|
113
|
-
|
114
|
-
p result
|
113
|
+
api_instance.delete_organization(tr_organization, organization_id)
|
115
114
|
rescue TrieveRubyClient::ApiError => e
|
116
|
-
puts "Error when calling OrganizationApi->
|
115
|
+
puts "Error when calling OrganizationApi->delete_organization: #{e}"
|
117
116
|
end
|
118
117
|
```
|
119
118
|
|
120
|
-
#### Using the
|
119
|
+
#### Using the delete_organization_with_http_info variant
|
121
120
|
|
122
|
-
This returns an Array which contains the response data, status code and headers.
|
121
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
123
122
|
|
124
|
-
> <Array(
|
123
|
+
> <Array(nil, Integer, Hash)> delete_organization_with_http_info(tr_organization, organization_id)
|
125
124
|
|
126
125
|
```ruby
|
127
126
|
begin
|
128
127
|
# Delete Organization
|
129
|
-
data, status_code, headers = api_instance.
|
128
|
+
data, status_code, headers = api_instance.delete_organization_with_http_info(tr_organization, organization_id)
|
130
129
|
p status_code # => 2xx
|
131
130
|
p headers # => { ... }
|
132
|
-
p data # =>
|
131
|
+
p data # => nil
|
133
132
|
rescue TrieveRubyClient::ApiError => e
|
134
|
-
puts "Error when calling OrganizationApi->
|
133
|
+
puts "Error when calling OrganizationApi->delete_organization_with_http_info: #{e}"
|
135
134
|
end
|
136
135
|
```
|
137
136
|
|
@@ -144,7 +143,7 @@ end
|
|
144
143
|
|
145
144
|
### Return type
|
146
145
|
|
147
|
-
|
146
|
+
nil (empty response body)
|
148
147
|
|
149
148
|
### Authorization
|
150
149
|
|
@@ -156,13 +155,13 @@ end
|
|
156
155
|
- **Accept**: application/json
|
157
156
|
|
158
157
|
|
159
|
-
##
|
158
|
+
## get_organization
|
160
159
|
|
161
|
-
> <Organization>
|
160
|
+
> <Organization> get_organization(tr_organization, organization_id)
|
162
161
|
|
163
162
|
Get Organization
|
164
163
|
|
165
|
-
|
164
|
+
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.
|
166
165
|
|
167
166
|
### Examples
|
168
167
|
|
@@ -183,28 +182,28 @@ organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of th
|
|
183
182
|
|
184
183
|
begin
|
185
184
|
# Get Organization
|
186
|
-
result = api_instance.
|
185
|
+
result = api_instance.get_organization(tr_organization, organization_id)
|
187
186
|
p result
|
188
187
|
rescue TrieveRubyClient::ApiError => e
|
189
|
-
puts "Error when calling OrganizationApi->
|
188
|
+
puts "Error when calling OrganizationApi->get_organization: #{e}"
|
190
189
|
end
|
191
190
|
```
|
192
191
|
|
193
|
-
#### Using the
|
192
|
+
#### Using the get_organization_with_http_info variant
|
194
193
|
|
195
194
|
This returns an Array which contains the response data, status code and headers.
|
196
195
|
|
197
|
-
> <Array(<Organization>, Integer, Hash)>
|
196
|
+
> <Array(<Organization>, Integer, Hash)> get_organization_with_http_info(tr_organization, organization_id)
|
198
197
|
|
199
198
|
```ruby
|
200
199
|
begin
|
201
200
|
# Get Organization
|
202
|
-
data, status_code, headers = api_instance.
|
201
|
+
data, status_code, headers = api_instance.get_organization_with_http_info(tr_organization, organization_id)
|
203
202
|
p status_code # => 2xx
|
204
203
|
p headers # => { ... }
|
205
204
|
p data # => <Organization>
|
206
205
|
rescue TrieveRubyClient::ApiError => e
|
207
|
-
puts "Error when calling OrganizationApi->
|
206
|
+
puts "Error when calling OrganizationApi->get_organization_with_http_info: #{e}"
|
208
207
|
end
|
209
208
|
```
|
210
209
|
|
@@ -235,7 +234,7 @@ end
|
|
235
234
|
|
236
235
|
Get Organization Usage
|
237
236
|
|
238
|
-
|
237
|
+
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.
|
239
238
|
|
240
239
|
### Examples
|
241
240
|
|
@@ -308,7 +307,7 @@ end
|
|
308
307
|
|
309
308
|
Get Organization Users
|
310
309
|
|
311
|
-
|
310
|
+
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.
|
312
311
|
|
313
312
|
### Examples
|
314
313
|
|
@@ -381,7 +380,7 @@ end
|
|
381
380
|
|
382
381
|
Update Organization
|
383
382
|
|
384
|
-
Update
|
383
|
+
Update an organization. Only the owner of the organization can update it.
|
385
384
|
|
386
385
|
### Examples
|
387
386
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrieveRubyClient::QueryCountResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total_queries** | [**Array<SearchTypeCount>**](SearchTypeCount.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
instance = TrieveRubyClient::QueryCountResponse.new(
|
15
|
+
total_queries: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::QueryDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **search_id** | **String** | | |
|
8
|
+
| **type** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::QueryDetails.new(
|
16
|
+
search_id: null,
|
17
|
+
type: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# TrieveRubyClient::RAGAnalytics
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
TrieveRubyClient::RAGAnalytics.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'RAGQueries',
|
18
|
+
# :'RAGUsage'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### `openapi_discriminator_name`
|
23
|
+
|
24
|
+
Returns the discriminator's property name.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'trieve_ruby_client'
|
30
|
+
|
31
|
+
TrieveRubyClient::RAGAnalytics.openapi_discriminator_name
|
32
|
+
# => :'type'
|
33
|
+
```
|
34
|
+
```
|
35
|
+
|
36
|
+
### build
|
37
|
+
|
38
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
39
|
+
|
40
|
+
#### Example
|
41
|
+
|
42
|
+
```ruby
|
43
|
+
require 'trieve_ruby_client'
|
44
|
+
|
45
|
+
TrieveRubyClient::RAGAnalytics.build(data)
|
46
|
+
# => #<RAGQueries:0x00007fdd4aab02a0>
|
47
|
+
|
48
|
+
TrieveRubyClient::RAGAnalytics.build(data_that_doesnt_match)
|
49
|
+
# => nil
|
50
|
+
```
|
51
|
+
|
52
|
+
#### Parameters
|
53
|
+
|
54
|
+
| Name | Type | Description |
|
55
|
+
| ---- | ---- | ----------- |
|
56
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
57
|
+
|
58
|
+
#### Return type
|
59
|
+
|
60
|
+
- `RAGQueries`
|
61
|
+
- `RAGUsage`
|
62
|
+
- `nil` (if no type matches)
|
63
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::RAGAnalyticsFilter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **date_range** | [**DateRange**](DateRange.md) | | [optional] |
|
8
|
+
| **rag_type** | [**RagTypes**](RagTypes.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::RAGAnalyticsFilter.new(
|
16
|
+
date_range: null,
|
17
|
+
rag_type: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|