trieve_ruby_client 0.10.7 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GENERATE_COMMAND.txt +2 -0
- data/README.md +119 -16
- data/docs/APIVersion.md +15 -0
- data/docs/AnalyticsApi.md +303 -0
- data/docs/AuthApi.md +4 -4
- data/docs/AutocompleteReqPayload.md +6 -2
- data/docs/BookmarkGroupResponse.md +49 -0
- data/docs/BookmarkGroupResult.md +1 -1
- data/docs/ChatMessageProxy.md +1 -1
- data/docs/ChunkApi.md +165 -63
- data/docs/ChunkFilter.md +2 -0
- data/docs/ChunkGroupAndFileId.md +36 -0
- data/docs/ChunkGroupApi.md +110 -90
- data/docs/ChunkMetadata.md +1 -1
- data/docs/ChunkMetadataStringTagSet.md +1 -1
- data/docs/ChunkMetadataWithScore.md +1 -1
- data/docs/ChunkReqPayload.md +2 -2
- data/docs/ChunkReturnTypes.md +49 -0
- data/docs/ClusterAnalytics.md +63 -0
- data/docs/ClusterAnalyticsFilter.md +18 -0
- data/docs/ClusterAnalyticsResponse.md +49 -0
- data/docs/ClusterQueries.md +22 -0
- data/docs/ClusterTopics.md +20 -0
- data/docs/ContentChunkMetadata.md +1 -1
- data/docs/CountChunkQueryResponseBody.md +18 -0
- data/docs/CountChunksReqPayload.md +26 -0
- data/docs/CountQueries.md +20 -0
- data/docs/CreateMessageReqPayload.md +11 -1
- data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
- data/docs/Dataset.md +0 -2
- data/docs/DatasetAnalytics.md +28 -0
- data/docs/DatasetApi.md +8 -80
- data/docs/DatasetDTO.md +0 -2
- data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
- data/docs/DistancePhrase.md +20 -0
- data/docs/EditMessageReqPayload.md +11 -1
- data/docs/Event.md +3 -5
- data/docs/EventTypeRequest.md +15 -0
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +4 -4
- data/docs/GenerateChunksRequest.md +11 -1
- data/docs/GeoInfoWithBias.md +20 -0
- data/docs/GetChunksForGroupsResponse.md +22 -0
- data/docs/GetEventsData.md +1 -1
- data/docs/Granularity.md +15 -0
- data/docs/GroupData.md +1 -1
- data/docs/GroupScoreChunk.md +14 -0
- data/docs/GroupsBookmarkQueryResult.md +22 -0
- data/docs/HeadQueries.md +20 -0
- data/docs/HeadQueries1.md +22 -0
- data/docs/HeadQueryResponse.md +18 -0
- data/docs/HealthApi.md +1 -1
- data/docs/InvitationApi.md +1 -1
- data/docs/LatencyGraph.md +22 -0
- data/docs/LatencyGraphResponse.md +18 -0
- data/docs/LowConfidenceQueries.md +24 -0
- data/docs/LowConfidenceRecommendations.md +24 -0
- data/docs/MessageApi.md +4 -4
- data/docs/MetricsApi.md +76 -0
- data/docs/NewChunkMetadataTypes.md +51 -0
- data/docs/NoResultQueries.md +22 -0
- data/docs/OrganizationApi.md +6 -6
- data/docs/QueryCountResponse.md +18 -0
- data/docs/QueryDetails.md +20 -0
- data/docs/RAGAnalytics.md +63 -0
- data/docs/RAGAnalyticsFilter.md +20 -0
- data/docs/RAGAnalyticsResponse.md +49 -0
- data/docs/RAGQueries.md +26 -0
- data/docs/RAGUsage.md +20 -0
- data/docs/RAGUsageResponse.md +18 -0
- data/docs/RPSGraph.md +22 -0
- data/docs/RPSGraphResponse.md +18 -0
- data/docs/RagQueryEvent.md +30 -0
- data/docs/RagQueryResponse.md +18 -0
- data/docs/RagTypes.md +15 -0
- data/docs/RecommendChunksRequest.md +2 -2
- data/docs/RecommendChunksResponseBody.md +18 -0
- data/docs/RecommendGroupChunksRequest.md +2 -2
- data/docs/RecommendGroupsResponse.md +49 -0
- data/docs/RecommendGroupsResponseBody.md +18 -0
- data/docs/RecommendResponseTypes.md +49 -0
- data/docs/RecommendType.md +15 -0
- data/docs/RecommendationAnalytics.md +63 -0
- data/docs/RecommendationAnalyticsFilter.md +20 -0
- data/docs/RecommendationAnalyticsResponse.md +47 -0
- data/docs/RecommendationEvent.md +38 -0
- data/docs/RecommendationQueries.md +26 -0
- data/docs/RecommendationStrategy.md +15 -0
- data/docs/RecommendationType.md +15 -0
- data/docs/RecommendationsEventResponse.md +18 -0
- data/docs/RegenerateMessageReqPayload.md +9 -1
- data/docs/RoleProxy.md +15 -0
- data/docs/ScoreChunk.md +22 -0
- data/docs/SearchAnalytics.md +77 -0
- data/docs/SearchAnalyticsFilter.md +22 -0
- data/docs/SearchAnalyticsResponse.md +59 -0
- data/docs/SearchChunksReqPayload.md +6 -4
- data/docs/SearchClusterResponse.md +18 -0
- data/docs/SearchClusterTopics.md +28 -0
- data/docs/SearchGroupResponseTypes.md +49 -0
- data/docs/SearchLatencyGraph.md +20 -0
- data/docs/SearchMethod.md +15 -0
- data/docs/SearchMetrics.md +20 -0
- data/docs/SearchOverGroupsData.md +2 -4
- data/docs/SearchOverGroupsResponseBody.md +4 -4
- data/docs/SearchOverGroupsResponseTypes.md +4 -4
- data/docs/SearchOverGroupsResults.md +6 -4
- data/docs/SearchQueries.md +26 -0
- data/docs/SearchQueryEvent.md +34 -0
- data/docs/SearchQueryResponse.md +18 -0
- data/docs/SearchRPSGraph.md +20 -0
- data/docs/SearchResponseBody.md +20 -0
- data/docs/SearchResponseTypes.md +49 -0
- data/docs/SearchResultType.md +49 -0
- data/docs/SearchType.md +15 -0
- data/docs/SearchTypeCount.md +22 -0
- data/docs/SearchWithinGroupData.md +6 -2
- data/docs/SearchWithinGroupResponseBody.md +20 -0
- data/docs/SearchWithinGroupResults.md +1 -1
- data/docs/SlimChunkMetadata.md +1 -1
- data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
- data/docs/SlimChunkMetadataWithScore.md +1 -1
- data/docs/SortBy.md +15 -0
- data/docs/SortOrder.md +15 -0
- data/docs/StripeApi.md +134 -4
- data/docs/StripeInvoice.md +28 -0
- data/docs/TopicApi.md +4 -4
- data/docs/UpdateChunkGroupData.md +3 -1
- data/docs/UpdateChunkReqPayload.md +2 -0
- data/docs/UserApi.md +3 -3
- data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
- data/lib/trieve_ruby_client/api/chunk_api.rb +148 -52
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +122 -107
- data/lib/trieve_ruby_client/api/dataset_api.rb +17 -81
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +9 -9
- data/lib/trieve_ruby_client/api/health_api.rb +3 -3
- data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
- data/lib/trieve_ruby_client/api/message_api.rb +9 -9
- data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +13 -13
- data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
- data/lib/trieve_ruby_client/api/topic_api.rb +9 -9
- data/lib/trieve_ruby_client/api/user_api.rb +7 -7
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +8 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_resp_body.rb +1 -1
- data/lib/trieve_ruby_client/models/api_version.rb +40 -0
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +47 -5
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
- data/lib/trieve_ruby_client/models/boost_phrase.rb +1 -1
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
- data/lib/trieve_ruby_client/models/chunk_filter.rb +13 -2
- data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +12 -15
- data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
- data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
- data/lib/trieve_ruby_client/models/condition_type.rb +1 -1
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +8 -2
- data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
- data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
- data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
- data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +1 -1
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +95 -4
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
- data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/date_range.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +95 -4
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +12 -24
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
- data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/file.rb +1 -1
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +78 -6
- data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
- data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
- data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
- data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +1 -1
- data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/granularity.rb +42 -0
- data/lib/trieve_ruby_client/models/group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
- data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
- data/lib/trieve_ruby_client/models/has_id_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
- data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
- data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
- data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
- data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
- data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
- data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
- data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
- data/lib/trieve_ruby_client/models/organization.rb +1 -1
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
- data/lib/trieve_ruby_client/models/query_details.rb +271 -0
- data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
- data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
- data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
- data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
- data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
- data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
- data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +84 -4
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
- data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
- data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
- data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +47 -16
- data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
- data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_method.rb +42 -0
- data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +26 -16
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
- data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
- data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
- data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_type.rb +42 -0
- data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +47 -5
- data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
- data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
- data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +12 -2
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +86 -5
- data/openapi-generator.yaml +2 -2
- data/openapi.json +11050 -1
- data/spec/api/analytics_api_spec.rb +87 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/models/api_version_spec.rb +30 -0
- data/spec/models/bookmark_group_response_spec.rb +32 -0
- data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
- data/spec/models/chunk_return_types_spec.rb +32 -0
- data/spec/models/cluster_analytics_filter_spec.rb +36 -0
- data/spec/models/cluster_analytics_response_spec.rb +32 -0
- data/spec/models/cluster_analytics_spec.rb +38 -0
- data/spec/models/cluster_queries_spec.rb +52 -0
- data/spec/models/cluster_topics_spec.rb +46 -0
- data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
- data/spec/models/count_chunks_req_payload_spec.rb +60 -0
- data/spec/models/count_queries_spec.rb +46 -0
- data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
- data/spec/models/dataset_analytics_spec.rb +66 -0
- data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
- data/spec/models/distance_phrase_spec.rb +42 -0
- data/spec/models/event_type_request_spec.rb +30 -0
- data/spec/models/geo_info_with_bias_spec.rb +42 -0
- data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
- data/spec/models/granularity_spec.rb +30 -0
- data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
- data/spec/models/head_queries1_spec.rb +52 -0
- data/spec/models/head_queries_spec.rb +42 -0
- data/spec/models/head_query_response_spec.rb +36 -0
- data/spec/models/latency_graph_response_spec.rb +36 -0
- data/spec/models/latency_graph_spec.rb +52 -0
- data/spec/models/low_confidence_queries_spec.rb +58 -0
- data/spec/models/low_confidence_recommendations_spec.rb +58 -0
- data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
- data/spec/models/no_result_queries_spec.rb +52 -0
- data/spec/models/query_count_response_spec.rb +36 -0
- data/spec/models/query_details_spec.rb +46 -0
- data/spec/models/rag_analytics_filter_spec.rb +42 -0
- data/spec/models/rag_analytics_response_spec.rb +32 -0
- data/spec/models/rag_analytics_spec.rb +38 -0
- data/spec/models/rag_queries_spec.rb +64 -0
- data/spec/models/rag_query_event_spec.rb +72 -0
- data/spec/models/rag_query_response_spec.rb +36 -0
- data/spec/models/rag_types_spec.rb +30 -0
- data/spec/models/rag_usage_response_spec.rb +36 -0
- data/spec/models/rag_usage_spec.rb +46 -0
- data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_spec.rb +32 -0
- data/spec/models/recommend_response_types_spec.rb +32 -0
- data/spec/models/recommend_type_spec.rb +30 -0
- data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
- data/spec/models/recommendation_analytics_response_spec.rb +32 -0
- data/spec/models/recommendation_analytics_spec.rb +38 -0
- data/spec/models/recommendation_event_spec.rb +96 -0
- data/spec/models/recommendation_queries_spec.rb +64 -0
- data/spec/models/recommendation_strategy_spec.rb +30 -0
- data/spec/models/recommendation_type_spec.rb +30 -0
- data/spec/models/recommendations_event_response_spec.rb +36 -0
- data/spec/models/role_proxy_spec.rb +30 -0
- data/spec/models/rps_graph_response_spec.rb +36 -0
- data/spec/models/rps_graph_spec.rb +52 -0
- data/spec/models/score_chunk_spec.rb +48 -0
- data/spec/models/search_analytics_filter_spec.rb +48 -0
- data/spec/models/search_analytics_response_spec.rb +32 -0
- data/spec/models/search_analytics_spec.rb +38 -0
- data/spec/models/search_cluster_response_spec.rb +36 -0
- data/spec/models/search_cluster_topics_spec.rb +66 -0
- data/spec/models/search_group_response_types_spec.rb +32 -0
- data/spec/models/search_latency_graph_spec.rb +42 -0
- data/spec/models/search_method_spec.rb +30 -0
- data/spec/models/search_metrics_spec.rb +46 -0
- data/spec/models/search_queries_spec.rb +64 -0
- data/spec/models/search_query_event_spec.rb +84 -0
- data/spec/models/search_query_response_spec.rb +36 -0
- data/spec/models/search_response_body_spec.rb +42 -0
- data/spec/models/search_response_types_spec.rb +32 -0
- data/spec/models/search_result_type_spec.rb +32 -0
- data/spec/models/search_rps_graph_spec.rb +42 -0
- data/spec/models/search_type_count_spec.rb +48 -0
- data/spec/models/search_type_spec.rb +30 -0
- data/spec/models/search_within_group_response_body_spec.rb +42 -0
- data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
- data/spec/models/sort_by_spec.rb +30 -0
- data/spec/models/sort_order_spec.rb +30 -0
- data/spec/models/stripe_invoice_spec.rb +66 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client.gemspec +1 -1
- metadata +456 -135
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client-0.6.2.gem +0 -0
- data/trieve_ruby_client-0.6.7.gem +0 -0
- data/trieve_ruby_client-0.6.9.gem +0 -0
- data/trieve_ruby_client-0.7.2.gem +0 -0
- data/trieve_ruby_client-0.7.6.gem +0 -0
- data/trieve_ruby_client-0.8.0.gem +0 -0
- data/trieve_ruby_client-0.8.2.gem +0 -0
- data/trieve_ruby_client-0.8.5.gem +0 -0
data/docs/ChunkGroupApi.md
CHANGED
@@ -14,8 +14,8 @@ All URIs are relative to *https://api.trieve.ai*
|
|
14
14
|
| [**get_chunks_in_group_by_tracking_id**](ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID |
|
15
15
|
| [**get_group_by_tracking_id**](ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID |
|
16
16
|
| [**get_groups_chunk_is_in**](ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks |
|
17
|
+
| [**get_groups_for_dataset**](ChunkGroupApi.md#get_groups_for_dataset) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset |
|
17
18
|
| [**get_recommended_groups**](ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups |
|
18
|
-
| [**get_specific_dataset_chunk_groups**](ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset |
|
19
19
|
| [**remove_chunk_from_group**](ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group |
|
20
20
|
| [**search_over_groups**](ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups |
|
21
21
|
| [**search_within_group**](ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group |
|
@@ -29,7 +29,7 @@ All URIs are relative to *https://api.trieve.ai*
|
|
29
29
|
|
30
30
|
Add Chunk to Group
|
31
31
|
|
32
|
-
|
32
|
+
Route to add a chunk to a group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
33
33
|
|
34
34
|
### Examples
|
35
35
|
|
@@ -103,7 +103,7 @@ nil (empty response body)
|
|
103
103
|
|
104
104
|
Add Chunk to Group by Tracking ID
|
105
105
|
|
106
|
-
|
106
|
+
Route to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
107
107
|
|
108
108
|
### Examples
|
109
109
|
|
@@ -177,7 +177,7 @@ nil (empty response body)
|
|
177
177
|
|
178
178
|
Create Chunk Group
|
179
179
|
|
180
|
-
Create
|
180
|
+
Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
181
181
|
|
182
182
|
### Examples
|
183
183
|
|
@@ -250,7 +250,7 @@ end
|
|
250
250
|
|
251
251
|
Delete Group
|
252
252
|
|
253
|
-
|
253
|
+
This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
254
254
|
|
255
255
|
### Examples
|
256
256
|
|
@@ -324,7 +324,7 @@ nil (empty response body)
|
|
324
324
|
|
325
325
|
Delete Group by Tracking ID
|
326
326
|
|
327
|
-
Delete
|
327
|
+
Delete a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
328
328
|
|
329
329
|
### Examples
|
330
330
|
|
@@ -394,11 +394,11 @@ nil (empty response body)
|
|
394
394
|
|
395
395
|
## get_chunk_group
|
396
396
|
|
397
|
-
> <
|
397
|
+
> <ChunkGroupAndFileId> get_chunk_group(tr_dataset, group_id)
|
398
398
|
|
399
399
|
Get Group
|
400
400
|
|
401
|
-
|
401
|
+
Fetch the group with the given id. get_group
|
402
402
|
|
403
403
|
### Examples
|
404
404
|
|
@@ -430,7 +430,7 @@ end
|
|
430
430
|
|
431
431
|
This returns an Array which contains the response data, status code and headers.
|
432
432
|
|
433
|
-
> <Array(<
|
433
|
+
> <Array(<ChunkGroupAndFileId>, Integer, Hash)> get_chunk_group_with_http_info(tr_dataset, group_id)
|
434
434
|
|
435
435
|
```ruby
|
436
436
|
begin
|
@@ -438,7 +438,7 @@ begin
|
|
438
438
|
data, status_code, headers = api_instance.get_chunk_group_with_http_info(tr_dataset, group_id)
|
439
439
|
p status_code # => 2xx
|
440
440
|
p headers # => { ... }
|
441
|
-
p data # => <
|
441
|
+
p data # => <ChunkGroupAndFileId>
|
442
442
|
rescue TrieveRubyClient::ApiError => e
|
443
443
|
puts "Error when calling ChunkGroupApi->get_chunk_group_with_http_info: #{e}"
|
444
444
|
end
|
@@ -453,7 +453,7 @@ end
|
|
453
453
|
|
454
454
|
### Return type
|
455
455
|
|
456
|
-
[**
|
456
|
+
[**ChunkGroupAndFileId**](ChunkGroupAndFileId.md)
|
457
457
|
|
458
458
|
### Authorization
|
459
459
|
|
@@ -467,11 +467,11 @@ end
|
|
467
467
|
|
468
468
|
## get_chunks_in_group
|
469
469
|
|
470
|
-
> <
|
470
|
+
> <BookmarkGroupResponse> get_chunks_in_group(tr_dataset, group_id, page, opts)
|
471
471
|
|
472
472
|
Get Chunks in Group
|
473
473
|
|
474
|
-
|
474
|
+
Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
475
475
|
|
476
476
|
### Examples
|
477
477
|
|
@@ -490,10 +490,13 @@ api_instance = TrieveRubyClient::ChunkGroupApi.new
|
|
490
490
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
491
491
|
group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to fetch.
|
492
492
|
page = 789 # Integer | The page of chunks to get from the group
|
493
|
+
opts = {
|
494
|
+
x_api_version: TrieveRubyClient::APIVersion::V1 # APIVersion | The version of the API to use for the request
|
495
|
+
}
|
493
496
|
|
494
497
|
begin
|
495
498
|
# Get Chunks in Group
|
496
|
-
result = api_instance.get_chunks_in_group(tr_dataset, group_id, page)
|
499
|
+
result = api_instance.get_chunks_in_group(tr_dataset, group_id, page, opts)
|
497
500
|
p result
|
498
501
|
rescue TrieveRubyClient::ApiError => e
|
499
502
|
puts "Error when calling ChunkGroupApi->get_chunks_in_group: #{e}"
|
@@ -504,15 +507,15 @@ end
|
|
504
507
|
|
505
508
|
This returns an Array which contains the response data, status code and headers.
|
506
509
|
|
507
|
-
> <Array(<
|
510
|
+
> <Array(<BookmarkGroupResponse>, Integer, Hash)> get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts)
|
508
511
|
|
509
512
|
```ruby
|
510
513
|
begin
|
511
514
|
# Get Chunks in Group
|
512
|
-
data, status_code, headers = api_instance.get_chunks_in_group_with_http_info(tr_dataset, group_id, page)
|
515
|
+
data, status_code, headers = api_instance.get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts)
|
513
516
|
p status_code # => 2xx
|
514
517
|
p headers # => { ... }
|
515
|
-
p data # => <
|
518
|
+
p data # => <BookmarkGroupResponse>
|
516
519
|
rescue TrieveRubyClient::ApiError => e
|
517
520
|
puts "Error when calling ChunkGroupApi->get_chunks_in_group_with_http_info: #{e}"
|
518
521
|
end
|
@@ -525,10 +528,11 @@ end
|
|
525
528
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
526
529
|
| **group_id** | **String** | Id of the group you want to fetch. | |
|
527
530
|
| **page** | **Integer** | The page of chunks to get from the group | |
|
531
|
+
| **x_api_version** | [**APIVersion**](.md) | The version of the API to use for the request | [optional] |
|
528
532
|
|
529
533
|
### Return type
|
530
534
|
|
531
|
-
[**
|
535
|
+
[**BookmarkGroupResponse**](BookmarkGroupResponse.md)
|
532
536
|
|
533
537
|
### Authorization
|
534
538
|
|
@@ -542,11 +546,11 @@ end
|
|
542
546
|
|
543
547
|
## get_chunks_in_group_by_tracking_id
|
544
548
|
|
545
|
-
> <
|
549
|
+
> <BookmarkGroupResponse> get_chunks_in_group_by_tracking_id(tr_dataset, group_tracking_id, page, opts)
|
546
550
|
|
547
551
|
Get Chunks in Group by Tracking ID
|
548
552
|
|
549
|
-
|
553
|
+
Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
|
550
554
|
|
551
555
|
### Examples
|
552
556
|
|
@@ -565,10 +569,13 @@ api_instance = TrieveRubyClient::ChunkGroupApi.new
|
|
565
569
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
566
570
|
group_tracking_id = 'group_tracking_id_example' # String | The id of the group to get the chunks from
|
567
571
|
page = 789 # Integer | The page of chunks to get from the group
|
572
|
+
opts = {
|
573
|
+
x_api_version: TrieveRubyClient::APIVersion::V1 # APIVersion | The version of the API to use for the request
|
574
|
+
}
|
568
575
|
|
569
576
|
begin
|
570
577
|
# Get Chunks in Group by Tracking ID
|
571
|
-
result = api_instance.get_chunks_in_group_by_tracking_id(tr_dataset, group_tracking_id, page)
|
578
|
+
result = api_instance.get_chunks_in_group_by_tracking_id(tr_dataset, group_tracking_id, page, opts)
|
572
579
|
p result
|
573
580
|
rescue TrieveRubyClient::ApiError => e
|
574
581
|
puts "Error when calling ChunkGroupApi->get_chunks_in_group_by_tracking_id: #{e}"
|
@@ -579,15 +586,15 @@ end
|
|
579
586
|
|
580
587
|
This returns an Array which contains the response data, status code and headers.
|
581
588
|
|
582
|
-
> <Array(<
|
589
|
+
> <Array(<BookmarkGroupResponse>, Integer, Hash)> get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page, opts)
|
583
590
|
|
584
591
|
```ruby
|
585
592
|
begin
|
586
593
|
# Get Chunks in Group by Tracking ID
|
587
|
-
data, status_code, headers = api_instance.get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page)
|
594
|
+
data, status_code, headers = api_instance.get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page, opts)
|
588
595
|
p status_code # => 2xx
|
589
596
|
p headers # => { ... }
|
590
|
-
p data # => <
|
597
|
+
p data # => <BookmarkGroupResponse>
|
591
598
|
rescue TrieveRubyClient::ApiError => e
|
592
599
|
puts "Error when calling ChunkGroupApi->get_chunks_in_group_by_tracking_id_with_http_info: #{e}"
|
593
600
|
end
|
@@ -600,10 +607,11 @@ end
|
|
600
607
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
601
608
|
| **group_tracking_id** | **String** | The id of the group to get the chunks from | |
|
602
609
|
| **page** | **Integer** | The page of chunks to get from the group | |
|
610
|
+
| **x_api_version** | [**APIVersion**](.md) | The version of the API to use for the request | [optional] |
|
603
611
|
|
604
612
|
### Return type
|
605
613
|
|
606
|
-
[**
|
614
|
+
[**BookmarkGroupResponse**](BookmarkGroupResponse.md)
|
607
615
|
|
608
616
|
### Authorization
|
609
617
|
|
@@ -617,11 +625,11 @@ end
|
|
617
625
|
|
618
626
|
## get_group_by_tracking_id
|
619
627
|
|
620
|
-
> <
|
628
|
+
> <ChunkGroupAndFileId> get_group_by_tracking_id(tr_dataset, tracking_id)
|
621
629
|
|
622
630
|
Get Group by Tracking ID
|
623
631
|
|
624
|
-
|
632
|
+
Fetch the group with the given tracking id. get_group_by_tracking_id
|
625
633
|
|
626
634
|
### Examples
|
627
635
|
|
@@ -653,7 +661,7 @@ end
|
|
653
661
|
|
654
662
|
This returns an Array which contains the response data, status code and headers.
|
655
663
|
|
656
|
-
> <Array(<
|
664
|
+
> <Array(<ChunkGroupAndFileId>, Integer, Hash)> get_group_by_tracking_id_with_http_info(tr_dataset, tracking_id)
|
657
665
|
|
658
666
|
```ruby
|
659
667
|
begin
|
@@ -661,7 +669,7 @@ begin
|
|
661
669
|
data, status_code, headers = api_instance.get_group_by_tracking_id_with_http_info(tr_dataset, tracking_id)
|
662
670
|
p status_code # => 2xx
|
663
671
|
p headers # => { ... }
|
664
|
-
p data # => <
|
672
|
+
p data # => <ChunkGroupAndFileId>
|
665
673
|
rescue TrieveRubyClient::ApiError => e
|
666
674
|
puts "Error when calling ChunkGroupApi->get_group_by_tracking_id_with_http_info: #{e}"
|
667
675
|
end
|
@@ -676,7 +684,7 @@ end
|
|
676
684
|
|
677
685
|
### Return type
|
678
686
|
|
679
|
-
[**
|
687
|
+
[**ChunkGroupAndFileId**](ChunkGroupAndFileId.md)
|
680
688
|
|
681
689
|
### Authorization
|
682
690
|
|
@@ -690,11 +698,11 @@ end
|
|
690
698
|
|
691
699
|
## get_groups_chunk_is_in
|
692
700
|
|
693
|
-
> <Array<
|
701
|
+
> <Array<BookmarkGroupResponse>> get_groups_chunk_is_in(tr_dataset, get_groups_for_chunks_data)
|
694
702
|
|
695
703
|
Get Groups for Chunks
|
696
704
|
|
697
|
-
|
705
|
+
Route to get the groups that a chunk is in.
|
698
706
|
|
699
707
|
### Examples
|
700
708
|
|
@@ -726,7 +734,7 @@ end
|
|
726
734
|
|
727
735
|
This returns an Array which contains the response data, status code and headers.
|
728
736
|
|
729
|
-
> <Array(<Array<
|
737
|
+
> <Array(<Array<BookmarkGroupResponse>>, Integer, Hash)> get_groups_chunk_is_in_with_http_info(tr_dataset, get_groups_for_chunks_data)
|
730
738
|
|
731
739
|
```ruby
|
732
740
|
begin
|
@@ -734,7 +742,7 @@ begin
|
|
734
742
|
data, status_code, headers = api_instance.get_groups_chunk_is_in_with_http_info(tr_dataset, get_groups_for_chunks_data)
|
735
743
|
p status_code # => 2xx
|
736
744
|
p headers # => { ... }
|
737
|
-
p data # => <Array<
|
745
|
+
p data # => <Array<BookmarkGroupResponse>>
|
738
746
|
rescue TrieveRubyClient::ApiError => e
|
739
747
|
puts "Error when calling ChunkGroupApi->get_groups_chunk_is_in_with_http_info: #{e}"
|
740
748
|
end
|
@@ -749,7 +757,7 @@ end
|
|
749
757
|
|
750
758
|
### Return type
|
751
759
|
|
752
|
-
[**Array<
|
760
|
+
[**Array<BookmarkGroupResponse>**](BookmarkGroupResponse.md)
|
753
761
|
|
754
762
|
### Authorization
|
755
763
|
|
@@ -761,13 +769,13 @@ end
|
|
761
769
|
- **Accept**: application/json
|
762
770
|
|
763
771
|
|
764
|
-
##
|
772
|
+
## get_groups_for_dataset
|
765
773
|
|
766
|
-
> <
|
774
|
+
> <GroupData> get_groups_for_dataset(tr_dataset, dataset_id, page)
|
767
775
|
|
768
|
-
Get
|
776
|
+
Get Groups for Dataset
|
769
777
|
|
770
|
-
|
778
|
+
Fetch the groups which belong to a dataset specified by its id.
|
771
779
|
|
772
780
|
### Examples
|
773
781
|
|
@@ -784,32 +792,33 @@ end
|
|
784
792
|
|
785
793
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
786
794
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
787
|
-
|
795
|
+
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset to fetch groups for.
|
796
|
+
page = 789 # Integer | The page of groups to fetch. Page is 1-indexed.
|
788
797
|
|
789
798
|
begin
|
790
|
-
# Get
|
791
|
-
result = api_instance.
|
799
|
+
# Get Groups for Dataset
|
800
|
+
result = api_instance.get_groups_for_dataset(tr_dataset, dataset_id, page)
|
792
801
|
p result
|
793
802
|
rescue TrieveRubyClient::ApiError => e
|
794
|
-
puts "Error when calling ChunkGroupApi->
|
803
|
+
puts "Error when calling ChunkGroupApi->get_groups_for_dataset: #{e}"
|
795
804
|
end
|
796
805
|
```
|
797
806
|
|
798
|
-
#### Using the
|
807
|
+
#### Using the get_groups_for_dataset_with_http_info variant
|
799
808
|
|
800
809
|
This returns an Array which contains the response data, status code and headers.
|
801
810
|
|
802
|
-
> <Array(<
|
811
|
+
> <Array(<GroupData>, Integer, Hash)> get_groups_for_dataset_with_http_info(tr_dataset, dataset_id, page)
|
803
812
|
|
804
813
|
```ruby
|
805
814
|
begin
|
806
|
-
# Get
|
807
|
-
data, status_code, headers = api_instance.
|
815
|
+
# Get Groups for Dataset
|
816
|
+
data, status_code, headers = api_instance.get_groups_for_dataset_with_http_info(tr_dataset, dataset_id, page)
|
808
817
|
p status_code # => 2xx
|
809
818
|
p headers # => { ... }
|
810
|
-
p data # => <
|
819
|
+
p data # => <GroupData>
|
811
820
|
rescue TrieveRubyClient::ApiError => e
|
812
|
-
puts "Error when calling ChunkGroupApi->
|
821
|
+
puts "Error when calling ChunkGroupApi->get_groups_for_dataset_with_http_info: #{e}"
|
813
822
|
end
|
814
823
|
```
|
815
824
|
|
@@ -818,11 +827,12 @@ end
|
|
818
827
|
| Name | Type | Description | Notes |
|
819
828
|
| ---- | ---- | ----------- | ----- |
|
820
829
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
821
|
-
| **
|
830
|
+
| **dataset_id** | **String** | The id of the dataset to fetch groups for. | |
|
831
|
+
| **page** | **Integer** | The page of groups to fetch. Page is 1-indexed. | |
|
822
832
|
|
823
833
|
### Return type
|
824
834
|
|
825
|
-
[**
|
835
|
+
[**GroupData**](GroupData.md)
|
826
836
|
|
827
837
|
### Authorization
|
828
838
|
|
@@ -830,17 +840,17 @@ end
|
|
830
840
|
|
831
841
|
### HTTP request headers
|
832
842
|
|
833
|
-
- **Content-Type**:
|
843
|
+
- **Content-Type**: Not defined
|
834
844
|
- **Accept**: application/json
|
835
845
|
|
836
846
|
|
837
|
-
##
|
847
|
+
## get_recommended_groups
|
838
848
|
|
839
|
-
> <
|
849
|
+
> <RecommendGroupsResponse> get_recommended_groups(tr_dataset, recommend_group_chunks_request, opts)
|
840
850
|
|
841
|
-
Get Groups
|
851
|
+
Get Recommended Groups
|
842
852
|
|
843
|
-
|
853
|
+
Route to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.
|
844
854
|
|
845
855
|
### Examples
|
846
856
|
|
@@ -857,33 +867,35 @@ end
|
|
857
867
|
|
858
868
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
859
869
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
860
|
-
|
861
|
-
|
870
|
+
recommend_group_chunks_request = TrieveRubyClient::RecommendGroupChunksRequest.new # RecommendGroupChunksRequest | JSON request payload to get recommendations of chunks similar to the chunks in the request
|
871
|
+
opts = {
|
872
|
+
x_api_version: TrieveRubyClient::APIVersion::V1 # APIVersion | The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
873
|
+
}
|
862
874
|
|
863
875
|
begin
|
864
|
-
# Get Groups
|
865
|
-
result = api_instance.
|
876
|
+
# Get Recommended Groups
|
877
|
+
result = api_instance.get_recommended_groups(tr_dataset, recommend_group_chunks_request, opts)
|
866
878
|
p result
|
867
879
|
rescue TrieveRubyClient::ApiError => e
|
868
|
-
puts "Error when calling ChunkGroupApi->
|
880
|
+
puts "Error when calling ChunkGroupApi->get_recommended_groups: #{e}"
|
869
881
|
end
|
870
882
|
```
|
871
883
|
|
872
|
-
#### Using the
|
884
|
+
#### Using the get_recommended_groups_with_http_info variant
|
873
885
|
|
874
886
|
This returns an Array which contains the response data, status code and headers.
|
875
887
|
|
876
|
-
> <Array(<
|
888
|
+
> <Array(<RecommendGroupsResponse>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts)
|
877
889
|
|
878
890
|
```ruby
|
879
891
|
begin
|
880
|
-
# Get Groups
|
881
|
-
data, status_code, headers = api_instance.
|
892
|
+
# Get Recommended Groups
|
893
|
+
data, status_code, headers = api_instance.get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts)
|
882
894
|
p status_code # => 2xx
|
883
895
|
p headers # => { ... }
|
884
|
-
p data # => <
|
896
|
+
p data # => <RecommendGroupsResponse>
|
885
897
|
rescue TrieveRubyClient::ApiError => e
|
886
|
-
puts "Error when calling ChunkGroupApi->
|
898
|
+
puts "Error when calling ChunkGroupApi->get_recommended_groups_with_http_info: #{e}"
|
887
899
|
end
|
888
900
|
```
|
889
901
|
|
@@ -892,12 +904,12 @@ end
|
|
892
904
|
| Name | Type | Description | Notes |
|
893
905
|
| ---- | ---- | ----------- | ----- |
|
894
906
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
895
|
-
| **
|
896
|
-
| **
|
907
|
+
| **recommend_group_chunks_request** | [**RecommendGroupChunksRequest**](RecommendGroupChunksRequest.md) | JSON request payload to get recommendations of chunks similar to the chunks in the request | |
|
908
|
+
| **x_api_version** | [**APIVersion**](.md) | The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise. | [optional] |
|
897
909
|
|
898
910
|
### Return type
|
899
911
|
|
900
|
-
[**
|
912
|
+
[**RecommendGroupsResponse**](RecommendGroupsResponse.md)
|
901
913
|
|
902
914
|
### Authorization
|
903
915
|
|
@@ -905,7 +917,7 @@ end
|
|
905
917
|
|
906
918
|
### HTTP request headers
|
907
919
|
|
908
|
-
- **Content-Type**:
|
920
|
+
- **Content-Type**: application/json
|
909
921
|
- **Accept**: application/json
|
910
922
|
|
911
923
|
|
@@ -915,7 +927,7 @@ end
|
|
915
927
|
|
916
928
|
Remove Chunk from Group
|
917
929
|
|
918
|
-
|
930
|
+
Route to remove a chunk from a group. Auth'ed user or api key must be an admin or owner of the dataset's organization to remove a chunk from a group.
|
919
931
|
|
920
932
|
### Examples
|
921
933
|
|
@@ -985,11 +997,11 @@ nil (empty response body)
|
|
985
997
|
|
986
998
|
## search_over_groups
|
987
999
|
|
988
|
-
> <
|
1000
|
+
> <SearchOverGroupsResponseTypes> search_over_groups(tr_dataset, search_over_groups_data, opts)
|
989
1001
|
|
990
1002
|
Search Over Groups
|
991
1003
|
|
992
|
-
|
1004
|
+
This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using scores from a cross encoder model. Compatible with semantic, fulltext, or hybrid search modes.
|
993
1005
|
|
994
1006
|
### Examples
|
995
1007
|
|
@@ -1006,11 +1018,14 @@ end
|
|
1006
1018
|
|
1007
1019
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
1008
1020
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
1009
|
-
search_over_groups_data = TrieveRubyClient::SearchOverGroupsData.new({query: 'query_example', search_type:
|
1021
|
+
search_over_groups_data = TrieveRubyClient::SearchOverGroupsData.new({query: 'query_example', search_type: TrieveRubyClient::SearchMethod::FULL_TEXT}) # SearchOverGroupsData | JSON request payload to semantically search over groups
|
1022
|
+
opts = {
|
1023
|
+
x_api_version: TrieveRubyClient::APIVersion::V1 # APIVersion | The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
1024
|
+
}
|
1010
1025
|
|
1011
1026
|
begin
|
1012
1027
|
# Search Over Groups
|
1013
|
-
result = api_instance.search_over_groups(tr_dataset, search_over_groups_data)
|
1028
|
+
result = api_instance.search_over_groups(tr_dataset, search_over_groups_data, opts)
|
1014
1029
|
p result
|
1015
1030
|
rescue TrieveRubyClient::ApiError => e
|
1016
1031
|
puts "Error when calling ChunkGroupApi->search_over_groups: #{e}"
|
@@ -1021,15 +1036,15 @@ end
|
|
1021
1036
|
|
1022
1037
|
This returns an Array which contains the response data, status code and headers.
|
1023
1038
|
|
1024
|
-
> <Array(<
|
1039
|
+
> <Array(<SearchOverGroupsResponseTypes>, Integer, Hash)> search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1025
1040
|
|
1026
1041
|
```ruby
|
1027
1042
|
begin
|
1028
1043
|
# Search Over Groups
|
1029
|
-
data, status_code, headers = api_instance.search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
|
1044
|
+
data, status_code, headers = api_instance.search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1030
1045
|
p status_code # => 2xx
|
1031
1046
|
p headers # => { ... }
|
1032
|
-
p data # => <
|
1047
|
+
p data # => <SearchOverGroupsResponseTypes>
|
1033
1048
|
rescue TrieveRubyClient::ApiError => e
|
1034
1049
|
puts "Error when calling ChunkGroupApi->search_over_groups_with_http_info: #{e}"
|
1035
1050
|
end
|
@@ -1041,10 +1056,11 @@ end
|
|
1041
1056
|
| ---- | ---- | ----------- | ----- |
|
1042
1057
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
1043
1058
|
| **search_over_groups_data** | [**SearchOverGroupsData**](SearchOverGroupsData.md) | JSON request payload to semantically search over groups | |
|
1059
|
+
| **x_api_version** | [**APIVersion**](.md) | The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise. | [optional] |
|
1044
1060
|
|
1045
1061
|
### Return type
|
1046
1062
|
|
1047
|
-
[**
|
1063
|
+
[**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md)
|
1048
1064
|
|
1049
1065
|
### Authorization
|
1050
1066
|
|
@@ -1058,11 +1074,11 @@ end
|
|
1058
1074
|
|
1059
1075
|
## search_within_group
|
1060
1076
|
|
1061
|
-
> <
|
1077
|
+
> <SearchGroupResponseTypes> search_within_group(tr_dataset, search_within_group_data, opts)
|
1062
1078
|
|
1063
1079
|
Search Within Group
|
1064
1080
|
|
1065
|
-
|
1081
|
+
This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using scores from a cross encoder model.
|
1066
1082
|
|
1067
1083
|
### Examples
|
1068
1084
|
|
@@ -1079,11 +1095,14 @@ end
|
|
1079
1095
|
|
1080
1096
|
api_instance = TrieveRubyClient::ChunkGroupApi.new
|
1081
1097
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
1082
|
-
search_within_group_data = TrieveRubyClient::SearchWithinGroupData.new({query: 'query_example', search_type:
|
1098
|
+
search_within_group_data = TrieveRubyClient::SearchWithinGroupData.new({query: 'query_example', search_type: TrieveRubyClient::SearchMethod::FULL_TEXT}) # SearchWithinGroupData | JSON request payload to semantically search a group
|
1099
|
+
opts = {
|
1100
|
+
x_api_version: TrieveRubyClient::APIVersion::V1 # APIVersion | The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
1101
|
+
}
|
1083
1102
|
|
1084
1103
|
begin
|
1085
1104
|
# Search Within Group
|
1086
|
-
result = api_instance.search_within_group(tr_dataset, search_within_group_data)
|
1105
|
+
result = api_instance.search_within_group(tr_dataset, search_within_group_data, opts)
|
1087
1106
|
p result
|
1088
1107
|
rescue TrieveRubyClient::ApiError => e
|
1089
1108
|
puts "Error when calling ChunkGroupApi->search_within_group: #{e}"
|
@@ -1094,15 +1113,15 @@ end
|
|
1094
1113
|
|
1095
1114
|
This returns an Array which contains the response data, status code and headers.
|
1096
1115
|
|
1097
|
-
> <Array(<
|
1116
|
+
> <Array(<SearchGroupResponseTypes>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1098
1117
|
|
1099
1118
|
```ruby
|
1100
1119
|
begin
|
1101
1120
|
# Search Within Group
|
1102
|
-
data, status_code, headers = api_instance.search_within_group_with_http_info(tr_dataset, search_within_group_data)
|
1121
|
+
data, status_code, headers = api_instance.search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1103
1122
|
p status_code # => 2xx
|
1104
1123
|
p headers # => { ... }
|
1105
|
-
p data # => <
|
1124
|
+
p data # => <SearchGroupResponseTypes>
|
1106
1125
|
rescue TrieveRubyClient::ApiError => e
|
1107
1126
|
puts "Error when calling ChunkGroupApi->search_within_group_with_http_info: #{e}"
|
1108
1127
|
end
|
@@ -1114,10 +1133,11 @@ end
|
|
1114
1133
|
| ---- | ---- | ----------- | ----- |
|
1115
1134
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
1116
1135
|
| **search_within_group_data** | [**SearchWithinGroupData**](SearchWithinGroupData.md) | JSON request payload to semantically search a group | |
|
1136
|
+
| **x_api_version** | [**APIVersion**](.md) | The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise. | [optional] |
|
1117
1137
|
|
1118
1138
|
### Return type
|
1119
1139
|
|
1120
|
-
[**
|
1140
|
+
[**SearchGroupResponseTypes**](SearchGroupResponseTypes.md)
|
1121
1141
|
|
1122
1142
|
### Authorization
|
1123
1143
|
|
@@ -1135,7 +1155,7 @@ end
|
|
1135
1155
|
|
1136
1156
|
Update Group
|
1137
1157
|
|
1138
|
-
Update
|
1158
|
+
Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
1139
1159
|
|
1140
1160
|
### Examples
|
1141
1161
|
|
@@ -1207,7 +1227,7 @@ nil (empty response body)
|
|
1207
1227
|
|
1208
1228
|
Update Group by Tracking ID
|
1209
1229
|
|
1210
|
-
Update
|
1230
|
+
Update a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
1211
1231
|
|
1212
1232
|
### Examples
|
1213
1233
|
|
data/docs/ChunkMetadata.md
CHANGED
@@ -13,7 +13,7 @@
|
|
13
13
|
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
14
14
|
| **metadata** | **Object** | | [optional] |
|
15
15
|
| **num_value** | **Float** | | [optional] |
|
16
|
-
| **qdrant_point_id** | **String** | |
|
16
|
+
| **qdrant_point_id** | **String** | | |
|
17
17
|
| **tag_set** | **Array<String>** | | [optional] |
|
18
18
|
| **time_stamp** | **Time** | | [optional] |
|
19
19
|
| **tracking_id** | **String** | | [optional] |
|
@@ -13,7 +13,7 @@
|
|
13
13
|
| **location** | [**GeoInfo**](GeoInfo.md) | | [optional] |
|
14
14
|
| **metadata** | **Object** | | [optional] |
|
15
15
|
| **num_value** | **Float** | | [optional] |
|
16
|
-
| **qdrant_point_id** | **String** | |
|
16
|
+
| **qdrant_point_id** | **String** | | |
|
17
17
|
| **tag_set** | **String** | | [optional] |
|
18
18
|
| **time_stamp** | **Time** | | [optional] |
|
19
19
|
| **tracking_id** | **String** | | [optional] |
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| **id** | **String** | | |
|
11
11
|
| **link** | **String** | | [optional] |
|
12
12
|
| **metadata** | **Object** | | [optional] |
|
13
|
-
| **qdrant_point_id** | **String** | |
|
13
|
+
| **qdrant_point_id** | **String** | | |
|
14
14
|
| **score** | **Float** | | |
|
15
15
|
| **tag_set** | **String** | | [optional] |
|
16
16
|
| **time_stamp** | **Time** | | [optional] |
|