trieve_ruby_client 0.10.7 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GENERATE_COMMAND.txt +2 -0
- data/README.md +119 -16
- data/docs/APIVersion.md +15 -0
- data/docs/AnalyticsApi.md +303 -0
- data/docs/AuthApi.md +4 -4
- data/docs/AutocompleteReqPayload.md +6 -2
- data/docs/BookmarkGroupResponse.md +49 -0
- data/docs/BookmarkGroupResult.md +1 -1
- data/docs/ChatMessageProxy.md +1 -1
- data/docs/ChunkApi.md +165 -63
- data/docs/ChunkFilter.md +2 -0
- data/docs/ChunkGroupAndFileId.md +36 -0
- data/docs/ChunkGroupApi.md +110 -90
- data/docs/ChunkMetadata.md +1 -1
- data/docs/ChunkMetadataStringTagSet.md +1 -1
- data/docs/ChunkMetadataWithScore.md +1 -1
- data/docs/ChunkReqPayload.md +2 -2
- data/docs/ChunkReturnTypes.md +49 -0
- data/docs/ClusterAnalytics.md +63 -0
- data/docs/ClusterAnalyticsFilter.md +18 -0
- data/docs/ClusterAnalyticsResponse.md +49 -0
- data/docs/ClusterQueries.md +22 -0
- data/docs/ClusterTopics.md +20 -0
- data/docs/ContentChunkMetadata.md +1 -1
- data/docs/CountChunkQueryResponseBody.md +18 -0
- data/docs/CountChunksReqPayload.md +26 -0
- data/docs/CountQueries.md +20 -0
- data/docs/CreateMessageReqPayload.md +11 -1
- data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
- data/docs/Dataset.md +0 -2
- data/docs/DatasetAnalytics.md +28 -0
- data/docs/DatasetApi.md +8 -80
- data/docs/DatasetDTO.md +0 -2
- data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
- data/docs/DistancePhrase.md +20 -0
- data/docs/EditMessageReqPayload.md +11 -1
- data/docs/Event.md +3 -5
- data/docs/EventTypeRequest.md +15 -0
- data/docs/EventsApi.md +1 -1
- data/docs/FileApi.md +4 -4
- data/docs/GenerateChunksRequest.md +11 -1
- data/docs/GeoInfoWithBias.md +20 -0
- data/docs/GetChunksForGroupsResponse.md +22 -0
- data/docs/GetEventsData.md +1 -1
- data/docs/Granularity.md +15 -0
- data/docs/GroupData.md +1 -1
- data/docs/GroupScoreChunk.md +14 -0
- data/docs/GroupsBookmarkQueryResult.md +22 -0
- data/docs/HeadQueries.md +20 -0
- data/docs/HeadQueries1.md +22 -0
- data/docs/HeadQueryResponse.md +18 -0
- data/docs/HealthApi.md +1 -1
- data/docs/InvitationApi.md +1 -1
- data/docs/LatencyGraph.md +22 -0
- data/docs/LatencyGraphResponse.md +18 -0
- data/docs/LowConfidenceQueries.md +24 -0
- data/docs/LowConfidenceRecommendations.md +24 -0
- data/docs/MessageApi.md +4 -4
- data/docs/MetricsApi.md +76 -0
- data/docs/NewChunkMetadataTypes.md +51 -0
- data/docs/NoResultQueries.md +22 -0
- data/docs/OrganizationApi.md +6 -6
- data/docs/QueryCountResponse.md +18 -0
- data/docs/QueryDetails.md +20 -0
- data/docs/RAGAnalytics.md +63 -0
- data/docs/RAGAnalyticsFilter.md +20 -0
- data/docs/RAGAnalyticsResponse.md +49 -0
- data/docs/RAGQueries.md +26 -0
- data/docs/RAGUsage.md +20 -0
- data/docs/RAGUsageResponse.md +18 -0
- data/docs/RPSGraph.md +22 -0
- data/docs/RPSGraphResponse.md +18 -0
- data/docs/RagQueryEvent.md +30 -0
- data/docs/RagQueryResponse.md +18 -0
- data/docs/RagTypes.md +15 -0
- data/docs/RecommendChunksRequest.md +2 -2
- data/docs/RecommendChunksResponseBody.md +18 -0
- data/docs/RecommendGroupChunksRequest.md +2 -2
- data/docs/RecommendGroupsResponse.md +49 -0
- data/docs/RecommendGroupsResponseBody.md +18 -0
- data/docs/RecommendResponseTypes.md +49 -0
- data/docs/RecommendType.md +15 -0
- data/docs/RecommendationAnalytics.md +63 -0
- data/docs/RecommendationAnalyticsFilter.md +20 -0
- data/docs/RecommendationAnalyticsResponse.md +47 -0
- data/docs/RecommendationEvent.md +38 -0
- data/docs/RecommendationQueries.md +26 -0
- data/docs/RecommendationStrategy.md +15 -0
- data/docs/RecommendationType.md +15 -0
- data/docs/RecommendationsEventResponse.md +18 -0
- data/docs/RegenerateMessageReqPayload.md +9 -1
- data/docs/RoleProxy.md +15 -0
- data/docs/ScoreChunk.md +22 -0
- data/docs/SearchAnalytics.md +77 -0
- data/docs/SearchAnalyticsFilter.md +22 -0
- data/docs/SearchAnalyticsResponse.md +59 -0
- data/docs/SearchChunksReqPayload.md +6 -4
- data/docs/SearchClusterResponse.md +18 -0
- data/docs/SearchClusterTopics.md +28 -0
- data/docs/SearchGroupResponseTypes.md +49 -0
- data/docs/SearchLatencyGraph.md +20 -0
- data/docs/SearchMethod.md +15 -0
- data/docs/SearchMetrics.md +20 -0
- data/docs/SearchOverGroupsData.md +2 -4
- data/docs/SearchOverGroupsResponseBody.md +4 -4
- data/docs/SearchOverGroupsResponseTypes.md +4 -4
- data/docs/SearchOverGroupsResults.md +6 -4
- data/docs/SearchQueries.md +26 -0
- data/docs/SearchQueryEvent.md +34 -0
- data/docs/SearchQueryResponse.md +18 -0
- data/docs/SearchRPSGraph.md +20 -0
- data/docs/SearchResponseBody.md +20 -0
- data/docs/SearchResponseTypes.md +49 -0
- data/docs/SearchResultType.md +49 -0
- data/docs/SearchType.md +15 -0
- data/docs/SearchTypeCount.md +22 -0
- data/docs/SearchWithinGroupData.md +6 -2
- data/docs/SearchWithinGroupResponseBody.md +20 -0
- data/docs/SearchWithinGroupResults.md +1 -1
- data/docs/SlimChunkMetadata.md +1 -1
- data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
- data/docs/SlimChunkMetadataWithScore.md +1 -1
- data/docs/SortBy.md +15 -0
- data/docs/SortOrder.md +15 -0
- data/docs/StripeApi.md +134 -4
- data/docs/StripeInvoice.md +28 -0
- data/docs/TopicApi.md +4 -4
- data/docs/UpdateChunkGroupData.md +3 -1
- data/docs/UpdateChunkReqPayload.md +2 -0
- data/docs/UserApi.md +3 -3
- data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
- data/lib/trieve_ruby_client/api/chunk_api.rb +148 -52
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +122 -107
- data/lib/trieve_ruby_client/api/dataset_api.rb +17 -81
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +9 -9
- data/lib/trieve_ruby_client/api/health_api.rb +3 -3
- data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
- data/lib/trieve_ruby_client/api/message_api.rb +9 -9
- data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +13 -13
- data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
- data/lib/trieve_ruby_client/api/topic_api.rb +9 -9
- data/lib/trieve_ruby_client/api/user_api.rb +7 -7
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +8 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_resp_body.rb +1 -1
- data/lib/trieve_ruby_client/models/api_version.rb +40 -0
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +47 -5
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
- data/lib/trieve_ruby_client/models/boost_phrase.rb +1 -1
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
- data/lib/trieve_ruby_client/models/chunk_filter.rb +13 -2
- data/lib/trieve_ruby_client/models/chunk_group.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +12 -15
- data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
- data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
- data/lib/trieve_ruby_client/models/condition_type.rb +1 -1
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +8 -2
- data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
- data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
- data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
- data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +1 -1
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +95 -4
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
- data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/date_range.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +95 -4
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +12 -24
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
- data/lib/trieve_ruby_client/models/field_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/file.rb +1 -1
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +78 -6
- data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
- data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
- data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
- data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +1 -1
- data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/granularity.rb +42 -0
- data/lib/trieve_ruby_client/models/group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
- data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
- data/lib/trieve_ruby_client/models/has_id_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
- data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
- data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
- data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
- data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
- data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
- data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
- data/lib/trieve_ruby_client/models/match_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
- data/lib/trieve_ruby_client/models/organization.rb +1 -1
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
- data/lib/trieve_ruby_client/models/query_details.rb +271 -0
- data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
- data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
- data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
- data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +1 -1
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
- data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
- data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
- data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +84 -4
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
- data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
- data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
- data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +47 -16
- data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
- data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_method.rb +42 -0
- data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +26 -16
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
- data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
- data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
- data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_type.rb +42 -0
- data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +47 -5
- data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
- data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
- data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +12 -2
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +86 -5
- data/openapi-generator.yaml +2 -2
- data/openapi.json +11050 -1
- data/spec/api/analytics_api_spec.rb +87 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/models/api_version_spec.rb +30 -0
- data/spec/models/bookmark_group_response_spec.rb +32 -0
- data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
- data/spec/models/chunk_return_types_spec.rb +32 -0
- data/spec/models/cluster_analytics_filter_spec.rb +36 -0
- data/spec/models/cluster_analytics_response_spec.rb +32 -0
- data/spec/models/cluster_analytics_spec.rb +38 -0
- data/spec/models/cluster_queries_spec.rb +52 -0
- data/spec/models/cluster_topics_spec.rb +46 -0
- data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
- data/spec/models/count_chunks_req_payload_spec.rb +60 -0
- data/spec/models/count_queries_spec.rb +46 -0
- data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
- data/spec/models/dataset_analytics_spec.rb +66 -0
- data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
- data/spec/models/distance_phrase_spec.rb +42 -0
- data/spec/models/event_type_request_spec.rb +30 -0
- data/spec/models/geo_info_with_bias_spec.rb +42 -0
- data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
- data/spec/models/granularity_spec.rb +30 -0
- data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
- data/spec/models/head_queries1_spec.rb +52 -0
- data/spec/models/head_queries_spec.rb +42 -0
- data/spec/models/head_query_response_spec.rb +36 -0
- data/spec/models/latency_graph_response_spec.rb +36 -0
- data/spec/models/latency_graph_spec.rb +52 -0
- data/spec/models/low_confidence_queries_spec.rb +58 -0
- data/spec/models/low_confidence_recommendations_spec.rb +58 -0
- data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
- data/spec/models/no_result_queries_spec.rb +52 -0
- data/spec/models/query_count_response_spec.rb +36 -0
- data/spec/models/query_details_spec.rb +46 -0
- data/spec/models/rag_analytics_filter_spec.rb +42 -0
- data/spec/models/rag_analytics_response_spec.rb +32 -0
- data/spec/models/rag_analytics_spec.rb +38 -0
- data/spec/models/rag_queries_spec.rb +64 -0
- data/spec/models/rag_query_event_spec.rb +72 -0
- data/spec/models/rag_query_response_spec.rb +36 -0
- data/spec/models/rag_types_spec.rb +30 -0
- data/spec/models/rag_usage_response_spec.rb +36 -0
- data/spec/models/rag_usage_spec.rb +46 -0
- data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_spec.rb +32 -0
- data/spec/models/recommend_response_types_spec.rb +32 -0
- data/spec/models/recommend_type_spec.rb +30 -0
- data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
- data/spec/models/recommendation_analytics_response_spec.rb +32 -0
- data/spec/models/recommendation_analytics_spec.rb +38 -0
- data/spec/models/recommendation_event_spec.rb +96 -0
- data/spec/models/recommendation_queries_spec.rb +64 -0
- data/spec/models/recommendation_strategy_spec.rb +30 -0
- data/spec/models/recommendation_type_spec.rb +30 -0
- data/spec/models/recommendations_event_response_spec.rb +36 -0
- data/spec/models/role_proxy_spec.rb +30 -0
- data/spec/models/rps_graph_response_spec.rb +36 -0
- data/spec/models/rps_graph_spec.rb +52 -0
- data/spec/models/score_chunk_spec.rb +48 -0
- data/spec/models/search_analytics_filter_spec.rb +48 -0
- data/spec/models/search_analytics_response_spec.rb +32 -0
- data/spec/models/search_analytics_spec.rb +38 -0
- data/spec/models/search_cluster_response_spec.rb +36 -0
- data/spec/models/search_cluster_topics_spec.rb +66 -0
- data/spec/models/search_group_response_types_spec.rb +32 -0
- data/spec/models/search_latency_graph_spec.rb +42 -0
- data/spec/models/search_method_spec.rb +30 -0
- data/spec/models/search_metrics_spec.rb +46 -0
- data/spec/models/search_queries_spec.rb +64 -0
- data/spec/models/search_query_event_spec.rb +84 -0
- data/spec/models/search_query_response_spec.rb +36 -0
- data/spec/models/search_response_body_spec.rb +42 -0
- data/spec/models/search_response_types_spec.rb +32 -0
- data/spec/models/search_result_type_spec.rb +32 -0
- data/spec/models/search_rps_graph_spec.rb +42 -0
- data/spec/models/search_type_count_spec.rb +48 -0
- data/spec/models/search_type_spec.rb +30 -0
- data/spec/models/search_within_group_response_body_spec.rb +42 -0
- data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
- data/spec/models/sort_by_spec.rb +30 -0
- data/spec/models/sort_order_spec.rb +30 -0
- data/spec/models/stripe_invoice_spec.rb +66 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client.gemspec +1 -1
- metadata +456 -135
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client-0.6.2.gem +0 -0
- data/trieve_ruby_client-0.6.7.gem +0 -0
- data/trieve_ruby_client-0.6.9.gem +0 -0
- data/trieve_ruby_client-0.7.2.gem +0 -0
- data/trieve_ruby_client-0.7.6.gem +0 -0
- data/trieve_ruby_client-0.8.0.gem +0 -0
- data/trieve_ruby_client-0.8.2.gem +0 -0
- data/trieve_ruby_client-0.8.5.gem +0 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Add Chunk to Group
|
23
|
-
#
|
23
|
+
# 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.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param group_id [String] Id of the group to add the chunk to as a bookmark
|
26
26
|
# @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
|
@@ -32,7 +32,7 @@ module TrieveRubyClient
|
|
32
32
|
end
|
33
33
|
|
34
34
|
# Add Chunk to Group
|
35
|
-
#
|
35
|
+
# 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.
|
36
36
|
# @param tr_dataset [String] The dataset id to use for the request
|
37
37
|
# @param group_id [String] Id of the group to add the chunk to as a bookmark
|
38
38
|
# @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
|
@@ -101,7 +101,7 @@ module TrieveRubyClient
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Add Chunk to Group by Tracking ID
|
104
|
-
#
|
104
|
+
# 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.
|
105
105
|
# @param tr_dataset [String] The dataset id to use for the request
|
106
106
|
# @param tracking_id [String] Id of the group to add the chunk to as a bookmark
|
107
107
|
# @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
|
@@ -113,7 +113,7 @@ module TrieveRubyClient
|
|
113
113
|
end
|
114
114
|
|
115
115
|
# Add Chunk to Group by Tracking ID
|
116
|
-
#
|
116
|
+
# 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.
|
117
117
|
# @param tr_dataset [String] The dataset id to use for the request
|
118
118
|
# @param tracking_id [String] Id of the group to add the chunk to as a bookmark
|
119
119
|
# @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
|
@@ -182,7 +182,7 @@ module TrieveRubyClient
|
|
182
182
|
end
|
183
183
|
|
184
184
|
# Create Chunk Group
|
185
|
-
# Create
|
185
|
+
# 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.
|
186
186
|
# @param tr_dataset [String] The dataset id to use for the request
|
187
187
|
# @param create_chunk_group_req_payload [CreateChunkGroupReqPayload] JSON request payload to cretea a chunkGroup
|
188
188
|
# @param [Hash] opts the optional parameters
|
@@ -193,7 +193,7 @@ module TrieveRubyClient
|
|
193
193
|
end
|
194
194
|
|
195
195
|
# Create Chunk Group
|
196
|
-
# Create
|
196
|
+
# 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.
|
197
197
|
# @param tr_dataset [String] The dataset id to use for the request
|
198
198
|
# @param create_chunk_group_req_payload [CreateChunkGroupReqPayload] JSON request payload to cretea a chunkGroup
|
199
199
|
# @param [Hash] opts the optional parameters
|
@@ -257,7 +257,7 @@ module TrieveRubyClient
|
|
257
257
|
end
|
258
258
|
|
259
259
|
# Delete Group
|
260
|
-
#
|
260
|
+
# 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.
|
261
261
|
# @param tr_dataset [String] The dataset id to use for the request
|
262
262
|
# @param group_id [String] Id of the group you want to fetch.
|
263
263
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -269,7 +269,7 @@ module TrieveRubyClient
|
|
269
269
|
end
|
270
270
|
|
271
271
|
# Delete Group
|
272
|
-
#
|
272
|
+
# 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.
|
273
273
|
# @param tr_dataset [String] The dataset id to use for the request
|
274
274
|
# @param group_id [String] Id of the group you want to fetch.
|
275
275
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -334,7 +334,7 @@ module TrieveRubyClient
|
|
334
334
|
end
|
335
335
|
|
336
336
|
# Delete Group by Tracking ID
|
337
|
-
# Delete
|
337
|
+
# 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.
|
338
338
|
# @param tr_dataset [String] The dataset id to use for the request
|
339
339
|
# @param tracking_id [String] Tracking id of the chunk_group to delete
|
340
340
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -346,7 +346,7 @@ module TrieveRubyClient
|
|
346
346
|
end
|
347
347
|
|
348
348
|
# Delete Group by Tracking ID
|
349
|
-
# Delete
|
349
|
+
# 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.
|
350
350
|
# @param tr_dataset [String] The dataset id to use for the request
|
351
351
|
# @param tracking_id [String] Tracking id of the chunk_group to delete
|
352
352
|
# @param delete_chunks [Boolean] Delete the chunks within the group
|
@@ -411,22 +411,22 @@ module TrieveRubyClient
|
|
411
411
|
end
|
412
412
|
|
413
413
|
# Get Group
|
414
|
-
#
|
414
|
+
# Fetch the group with the given id. get_group
|
415
415
|
# @param tr_dataset [String] The dataset id to use for the request
|
416
416
|
# @param group_id [String] Id of the group you want to fetch.
|
417
417
|
# @param [Hash] opts the optional parameters
|
418
|
-
# @return [
|
418
|
+
# @return [ChunkGroupAndFileId]
|
419
419
|
def get_chunk_group(tr_dataset, group_id, opts = {})
|
420
420
|
data, _status_code, _headers = get_chunk_group_with_http_info(tr_dataset, group_id, opts)
|
421
421
|
data
|
422
422
|
end
|
423
423
|
|
424
424
|
# Get Group
|
425
|
-
#
|
425
|
+
# Fetch the group with the given id. get_group
|
426
426
|
# @param tr_dataset [String] The dataset id to use for the request
|
427
427
|
# @param group_id [String] Id of the group you want to fetch.
|
428
428
|
# @param [Hash] opts the optional parameters
|
429
|
-
# @return [Array<(
|
429
|
+
# @return [Array<(ChunkGroupAndFileId, Integer, Hash)>] ChunkGroupAndFileId data, response status code and response headers
|
430
430
|
def get_chunk_group_with_http_info(tr_dataset, group_id, opts = {})
|
431
431
|
if @api_client.config.debugging
|
432
432
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunk_group ...'
|
@@ -458,7 +458,7 @@ module TrieveRubyClient
|
|
458
458
|
post_body = opts[:debug_body]
|
459
459
|
|
460
460
|
# return_type
|
461
|
-
return_type = opts[:debug_return_type] || '
|
461
|
+
return_type = opts[:debug_return_type] || 'ChunkGroupAndFileId'
|
462
462
|
|
463
463
|
# auth_names
|
464
464
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -481,24 +481,26 @@ module TrieveRubyClient
|
|
481
481
|
end
|
482
482
|
|
483
483
|
# Get Chunks in Group
|
484
|
-
#
|
484
|
+
# Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
485
485
|
# @param tr_dataset [String] The dataset id to use for the request
|
486
486
|
# @param group_id [String] Id of the group you want to fetch.
|
487
487
|
# @param page [Integer] The page of chunks to get from the group
|
488
488
|
# @param [Hash] opts the optional parameters
|
489
|
-
# @
|
489
|
+
# @option opts [APIVersion] :x_api_version The version of the API to use for the request
|
490
|
+
# @return [BookmarkGroupResponse]
|
490
491
|
def get_chunks_in_group(tr_dataset, group_id, page, opts = {})
|
491
492
|
data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts)
|
492
493
|
data
|
493
494
|
end
|
494
495
|
|
495
496
|
# Get Chunks in Group
|
496
|
-
#
|
497
|
+
# Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
497
498
|
# @param tr_dataset [String] The dataset id to use for the request
|
498
499
|
# @param group_id [String] Id of the group you want to fetch.
|
499
500
|
# @param page [Integer] The page of chunks to get from the group
|
500
501
|
# @param [Hash] opts the optional parameters
|
501
|
-
# @
|
502
|
+
# @option opts [APIVersion] :x_api_version The version of the API to use for the request
|
503
|
+
# @return [Array<(BookmarkGroupResponse, Integer, Hash)>] BookmarkGroupResponse data, response status code and response headers
|
502
504
|
def get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts = {})
|
503
505
|
if @api_client.config.debugging
|
504
506
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunks_in_group ...'
|
@@ -526,6 +528,7 @@ module TrieveRubyClient
|
|
526
528
|
# HTTP header 'Accept' (if needed)
|
527
529
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
528
530
|
header_params[:'TR-Dataset'] = tr_dataset
|
531
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
529
532
|
|
530
533
|
# form parameters
|
531
534
|
form_params = opts[:form_params] || {}
|
@@ -534,7 +537,7 @@ module TrieveRubyClient
|
|
534
537
|
post_body = opts[:debug_body]
|
535
538
|
|
536
539
|
# return_type
|
537
|
-
return_type = opts[:debug_return_type] || '
|
540
|
+
return_type = opts[:debug_return_type] || 'BookmarkGroupResponse'
|
538
541
|
|
539
542
|
# auth_names
|
540
543
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -557,24 +560,26 @@ module TrieveRubyClient
|
|
557
560
|
end
|
558
561
|
|
559
562
|
# Get Chunks in Group by Tracking ID
|
560
|
-
#
|
563
|
+
# 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.
|
561
564
|
# @param tr_dataset [String] The dataset id to use for the request
|
562
565
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
563
566
|
# @param page [Integer] The page of chunks to get from the group
|
564
567
|
# @param [Hash] opts the optional parameters
|
565
|
-
# @
|
568
|
+
# @option opts [APIVersion] :x_api_version The version of the API to use for the request
|
569
|
+
# @return [BookmarkGroupResponse]
|
566
570
|
def get_chunks_in_group_by_tracking_id(tr_dataset, group_tracking_id, page, opts = {})
|
567
571
|
data, _status_code, _headers = get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page, opts)
|
568
572
|
data
|
569
573
|
end
|
570
574
|
|
571
575
|
# Get Chunks in Group by Tracking ID
|
572
|
-
#
|
576
|
+
# 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.
|
573
577
|
# @param tr_dataset [String] The dataset id to use for the request
|
574
578
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
575
579
|
# @param page [Integer] The page of chunks to get from the group
|
576
580
|
# @param [Hash] opts the optional parameters
|
577
|
-
# @
|
581
|
+
# @option opts [APIVersion] :x_api_version The version of the API to use for the request
|
582
|
+
# @return [Array<(BookmarkGroupResponse, Integer, Hash)>] BookmarkGroupResponse data, response status code and response headers
|
578
583
|
def get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page, opts = {})
|
579
584
|
if @api_client.config.debugging
|
580
585
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunks_in_group_by_tracking_id ...'
|
@@ -606,6 +611,7 @@ module TrieveRubyClient
|
|
606
611
|
# HTTP header 'Accept' (if needed)
|
607
612
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
608
613
|
header_params[:'TR-Dataset'] = tr_dataset
|
614
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
609
615
|
|
610
616
|
# form parameters
|
611
617
|
form_params = opts[:form_params] || {}
|
@@ -614,7 +620,7 @@ module TrieveRubyClient
|
|
614
620
|
post_body = opts[:debug_body]
|
615
621
|
|
616
622
|
# return_type
|
617
|
-
return_type = opts[:debug_return_type] || '
|
623
|
+
return_type = opts[:debug_return_type] || 'BookmarkGroupResponse'
|
618
624
|
|
619
625
|
# auth_names
|
620
626
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -637,22 +643,22 @@ module TrieveRubyClient
|
|
637
643
|
end
|
638
644
|
|
639
645
|
# Get Group by Tracking ID
|
640
|
-
#
|
646
|
+
# Fetch the group with the given tracking id. get_group_by_tracking_id
|
641
647
|
# @param tr_dataset [String] The dataset id to use for the request
|
642
648
|
# @param tracking_id [String] The tracking id of the group to fetch.
|
643
649
|
# @param [Hash] opts the optional parameters
|
644
|
-
# @return [
|
650
|
+
# @return [ChunkGroupAndFileId]
|
645
651
|
def get_group_by_tracking_id(tr_dataset, tracking_id, opts = {})
|
646
652
|
data, _status_code, _headers = get_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
|
647
653
|
data
|
648
654
|
end
|
649
655
|
|
650
656
|
# Get Group by Tracking ID
|
651
|
-
#
|
657
|
+
# Fetch the group with the given tracking id. get_group_by_tracking_id
|
652
658
|
# @param tr_dataset [String] The dataset id to use for the request
|
653
659
|
# @param tracking_id [String] The tracking id of the group to fetch.
|
654
660
|
# @param [Hash] opts the optional parameters
|
655
|
-
# @return [Array<(
|
661
|
+
# @return [Array<(ChunkGroupAndFileId, Integer, Hash)>] ChunkGroupAndFileId data, response status code and response headers
|
656
662
|
def get_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
|
657
663
|
if @api_client.config.debugging
|
658
664
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_group_by_tracking_id ...'
|
@@ -684,7 +690,7 @@ module TrieveRubyClient
|
|
684
690
|
post_body = opts[:debug_body]
|
685
691
|
|
686
692
|
# return_type
|
687
|
-
return_type = opts[:debug_return_type] || '
|
693
|
+
return_type = opts[:debug_return_type] || 'ChunkGroupAndFileId'
|
688
694
|
|
689
695
|
# auth_names
|
690
696
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -707,22 +713,22 @@ module TrieveRubyClient
|
|
707
713
|
end
|
708
714
|
|
709
715
|
# Get Groups for Chunks
|
710
|
-
#
|
716
|
+
# Route to get the groups that a chunk is in.
|
711
717
|
# @param tr_dataset [String] The dataset id to use for the request
|
712
718
|
# @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
|
713
719
|
# @param [Hash] opts the optional parameters
|
714
|
-
# @return [Array<
|
720
|
+
# @return [Array<BookmarkGroupResponse>]
|
715
721
|
def get_groups_chunk_is_in(tr_dataset, get_groups_for_chunks_data, opts = {})
|
716
722
|
data, _status_code, _headers = get_groups_chunk_is_in_with_http_info(tr_dataset, get_groups_for_chunks_data, opts)
|
717
723
|
data
|
718
724
|
end
|
719
725
|
|
720
726
|
# Get Groups for Chunks
|
721
|
-
#
|
727
|
+
# Route to get the groups that a chunk is in.
|
722
728
|
# @param tr_dataset [String] The dataset id to use for the request
|
723
729
|
# @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
|
724
730
|
# @param [Hash] opts the optional parameters
|
725
|
-
# @return [Array<(Array<
|
731
|
+
# @return [Array<(Array<BookmarkGroupResponse>, Integer, Hash)>] Array<BookmarkGroupResponse> data, response status code and response headers
|
726
732
|
def get_groups_chunk_is_in_with_http_info(tr_dataset, get_groups_for_chunks_data, opts = {})
|
727
733
|
if @api_client.config.debugging
|
728
734
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_groups_chunk_is_in ...'
|
@@ -759,7 +765,7 @@ module TrieveRubyClient
|
|
759
765
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_groups_for_chunks_data)
|
760
766
|
|
761
767
|
# return_type
|
762
|
-
return_type = opts[:debug_return_type] || 'Array<
|
768
|
+
return_type = opts[:debug_return_type] || 'Array<BookmarkGroupResponse>'
|
763
769
|
|
764
770
|
# auth_names
|
765
771
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -781,37 +787,43 @@ module TrieveRubyClient
|
|
781
787
|
return data, status_code, headers
|
782
788
|
end
|
783
789
|
|
784
|
-
# Get
|
785
|
-
#
|
790
|
+
# Get Groups for Dataset
|
791
|
+
# Fetch the groups which belong to a dataset specified by its id.
|
786
792
|
# @param tr_dataset [String] The dataset id to use for the request
|
787
|
-
# @param
|
793
|
+
# @param dataset_id [String] The id of the dataset to fetch groups for.
|
794
|
+
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
788
795
|
# @param [Hash] opts the optional parameters
|
789
|
-
# @return [
|
790
|
-
def
|
791
|
-
data, _status_code, _headers =
|
796
|
+
# @return [GroupData]
|
797
|
+
def get_groups_for_dataset(tr_dataset, dataset_id, page, opts = {})
|
798
|
+
data, _status_code, _headers = get_groups_for_dataset_with_http_info(tr_dataset, dataset_id, page, opts)
|
792
799
|
data
|
793
800
|
end
|
794
801
|
|
795
|
-
# Get
|
796
|
-
#
|
802
|
+
# Get Groups for Dataset
|
803
|
+
# Fetch the groups which belong to a dataset specified by its id.
|
797
804
|
# @param tr_dataset [String] The dataset id to use for the request
|
798
|
-
# @param
|
805
|
+
# @param dataset_id [String] The id of the dataset to fetch groups for.
|
806
|
+
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
799
807
|
# @param [Hash] opts the optional parameters
|
800
|
-
# @return [Array<(
|
801
|
-
def
|
808
|
+
# @return [Array<(GroupData, Integer, Hash)>] GroupData data, response status code and response headers
|
809
|
+
def get_groups_for_dataset_with_http_info(tr_dataset, dataset_id, page, opts = {})
|
802
810
|
if @api_client.config.debugging
|
803
|
-
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.
|
811
|
+
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_groups_for_dataset ...'
|
804
812
|
end
|
805
813
|
# verify the required parameter 'tr_dataset' is set
|
806
814
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
807
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.
|
815
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_groups_for_dataset"
|
808
816
|
end
|
809
|
-
# verify the required parameter '
|
810
|
-
if @api_client.config.client_side_validation &&
|
811
|
-
fail ArgumentError, "Missing the required parameter '
|
817
|
+
# verify the required parameter 'dataset_id' is set
|
818
|
+
if @api_client.config.client_side_validation && dataset_id.nil?
|
819
|
+
fail ArgumentError, "Missing the required parameter 'dataset_id' when calling ChunkGroupApi.get_groups_for_dataset"
|
820
|
+
end
|
821
|
+
# verify the required parameter 'page' is set
|
822
|
+
if @api_client.config.client_side_validation && page.nil?
|
823
|
+
fail ArgumentError, "Missing the required parameter 'page' when calling ChunkGroupApi.get_groups_for_dataset"
|
812
824
|
end
|
813
825
|
# resource path
|
814
|
-
local_var_path = '/api/
|
826
|
+
local_var_path = '/api/dataset/groups/{dataset_id}/{page}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s)).sub('{' + 'page' + '}', CGI.escape(page.to_s))
|
815
827
|
|
816
828
|
# query parameters
|
817
829
|
query_params = opts[:query_params] || {}
|
@@ -820,27 +832,22 @@ module TrieveRubyClient
|
|
820
832
|
header_params = opts[:header_params] || {}
|
821
833
|
# HTTP header 'Accept' (if needed)
|
822
834
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
823
|
-
# HTTP header 'Content-Type'
|
824
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
825
|
-
if !content_type.nil?
|
826
|
-
header_params['Content-Type'] = content_type
|
827
|
-
end
|
828
835
|
header_params[:'TR-Dataset'] = tr_dataset
|
829
836
|
|
830
837
|
# form parameters
|
831
838
|
form_params = opts[:form_params] || {}
|
832
839
|
|
833
840
|
# http body (model)
|
834
|
-
post_body = opts[:debug_body]
|
841
|
+
post_body = opts[:debug_body]
|
835
842
|
|
836
843
|
# return_type
|
837
|
-
return_type = opts[:debug_return_type] || '
|
844
|
+
return_type = opts[:debug_return_type] || 'GroupData'
|
838
845
|
|
839
846
|
# auth_names
|
840
847
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
841
848
|
|
842
849
|
new_options = opts.merge(
|
843
|
-
:operation => :"ChunkGroupApi.
|
850
|
+
:operation => :"ChunkGroupApi.get_groups_for_dataset",
|
844
851
|
:header_params => header_params,
|
845
852
|
:query_params => query_params,
|
846
853
|
:form_params => form_params,
|
@@ -849,50 +856,46 @@ module TrieveRubyClient
|
|
849
856
|
:return_type => return_type
|
850
857
|
)
|
851
858
|
|
852
|
-
data, status_code, headers = @api_client.call_api(:
|
859
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
853
860
|
if @api_client.config.debugging
|
854
|
-
@api_client.config.logger.debug "API called: ChunkGroupApi#
|
861
|
+
@api_client.config.logger.debug "API called: ChunkGroupApi#get_groups_for_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
855
862
|
end
|
856
863
|
return data, status_code, headers
|
857
864
|
end
|
858
865
|
|
859
|
-
# Get Groups
|
860
|
-
#
|
866
|
+
# Get Recommended Groups
|
867
|
+
# 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.
|
861
868
|
# @param tr_dataset [String] The dataset id to use for the request
|
862
|
-
# @param
|
863
|
-
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
869
|
+
# @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
864
870
|
# @param [Hash] opts the optional parameters
|
865
|
-
# @
|
866
|
-
|
867
|
-
|
871
|
+
# @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
872
|
+
# @return [RecommendGroupsResponse]
|
873
|
+
def get_recommended_groups(tr_dataset, recommend_group_chunks_request, opts = {})
|
874
|
+
data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts)
|
868
875
|
data
|
869
876
|
end
|
870
877
|
|
871
|
-
# Get Groups
|
872
|
-
#
|
878
|
+
# Get Recommended Groups
|
879
|
+
# 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.
|
873
880
|
# @param tr_dataset [String] The dataset id to use for the request
|
874
|
-
# @param
|
875
|
-
# @param page [Integer] The page of groups to fetch. Page is 1-indexed.
|
881
|
+
# @param recommend_group_chunks_request [RecommendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
|
876
882
|
# @param [Hash] opts the optional parameters
|
877
|
-
# @
|
878
|
-
|
883
|
+
# @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
884
|
+
# @return [Array<(RecommendGroupsResponse, Integer, Hash)>] RecommendGroupsResponse data, response status code and response headers
|
885
|
+
def get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request, opts = {})
|
879
886
|
if @api_client.config.debugging
|
880
|
-
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.
|
887
|
+
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_recommended_groups ...'
|
881
888
|
end
|
882
889
|
# verify the required parameter 'tr_dataset' is set
|
883
890
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
884
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.
|
885
|
-
end
|
886
|
-
# verify the required parameter 'dataset_id' is set
|
887
|
-
if @api_client.config.client_side_validation && dataset_id.nil?
|
888
|
-
fail ArgumentError, "Missing the required parameter 'dataset_id' when calling ChunkGroupApi.get_specific_dataset_chunk_groups"
|
891
|
+
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_recommended_groups"
|
889
892
|
end
|
890
|
-
# verify the required parameter '
|
891
|
-
if @api_client.config.client_side_validation &&
|
892
|
-
fail ArgumentError, "Missing the required parameter '
|
893
|
+
# verify the required parameter 'recommend_group_chunks_request' is set
|
894
|
+
if @api_client.config.client_side_validation && recommend_group_chunks_request.nil?
|
895
|
+
fail ArgumentError, "Missing the required parameter 'recommend_group_chunks_request' when calling ChunkGroupApi.get_recommended_groups"
|
893
896
|
end
|
894
897
|
# resource path
|
895
|
-
local_var_path = '/api/
|
898
|
+
local_var_path = '/api/chunk_group/recommend'
|
896
899
|
|
897
900
|
# query parameters
|
898
901
|
query_params = opts[:query_params] || {}
|
@@ -901,22 +904,28 @@ module TrieveRubyClient
|
|
901
904
|
header_params = opts[:header_params] || {}
|
902
905
|
# HTTP header 'Accept' (if needed)
|
903
906
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
907
|
+
# HTTP header 'Content-Type'
|
908
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
909
|
+
if !content_type.nil?
|
910
|
+
header_params['Content-Type'] = content_type
|
911
|
+
end
|
904
912
|
header_params[:'TR-Dataset'] = tr_dataset
|
913
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
905
914
|
|
906
915
|
# form parameters
|
907
916
|
form_params = opts[:form_params] || {}
|
908
917
|
|
909
918
|
# http body (model)
|
910
|
-
post_body = opts[:debug_body]
|
919
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_group_chunks_request)
|
911
920
|
|
912
921
|
# return_type
|
913
|
-
return_type = opts[:debug_return_type] || '
|
922
|
+
return_type = opts[:debug_return_type] || 'RecommendGroupsResponse'
|
914
923
|
|
915
924
|
# auth_names
|
916
925
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
917
926
|
|
918
927
|
new_options = opts.merge(
|
919
|
-
:operation => :"ChunkGroupApi.
|
928
|
+
:operation => :"ChunkGroupApi.get_recommended_groups",
|
920
929
|
:header_params => header_params,
|
921
930
|
:query_params => query_params,
|
922
931
|
:form_params => form_params,
|
@@ -925,15 +934,15 @@ module TrieveRubyClient
|
|
925
934
|
:return_type => return_type
|
926
935
|
)
|
927
936
|
|
928
|
-
data, status_code, headers = @api_client.call_api(:
|
937
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
929
938
|
if @api_client.config.debugging
|
930
|
-
@api_client.config.logger.debug "API called: ChunkGroupApi#
|
939
|
+
@api_client.config.logger.debug "API called: ChunkGroupApi#get_recommended_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
931
940
|
end
|
932
941
|
return data, status_code, headers
|
933
942
|
end
|
934
943
|
|
935
944
|
# Remove Chunk from Group
|
936
|
-
#
|
945
|
+
# 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.
|
937
946
|
# @param tr_dataset [String] The dataset id to use for the request
|
938
947
|
# @param group_id [String] Id of the group you want to remove the chunk from.
|
939
948
|
# @param remove_chunk_from_group_req_payload [RemoveChunkFromGroupReqPayload] JSON request payload to remove a chunk from a group
|
@@ -945,7 +954,7 @@ module TrieveRubyClient
|
|
945
954
|
end
|
946
955
|
|
947
956
|
# Remove Chunk from Group
|
948
|
-
#
|
957
|
+
# 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.
|
949
958
|
# @param tr_dataset [String] The dataset id to use for the request
|
950
959
|
# @param group_id [String] Id of the group you want to remove the chunk from.
|
951
960
|
# @param remove_chunk_from_group_req_payload [RemoveChunkFromGroupReqPayload] JSON request payload to remove a chunk from a group
|
@@ -1014,22 +1023,24 @@ module TrieveRubyClient
|
|
1014
1023
|
end
|
1015
1024
|
|
1016
1025
|
# Search Over Groups
|
1017
|
-
#
|
1026
|
+
# 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.
|
1018
1027
|
# @param tr_dataset [String] The dataset id to use for the request
|
1019
1028
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1020
1029
|
# @param [Hash] opts the optional parameters
|
1021
|
-
# @
|
1030
|
+
# @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
1031
|
+
# @return [SearchOverGroupsResponseTypes]
|
1022
1032
|
def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
|
1023
1033
|
data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1024
1034
|
data
|
1025
1035
|
end
|
1026
1036
|
|
1027
1037
|
# Search Over Groups
|
1028
|
-
#
|
1038
|
+
# 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.
|
1029
1039
|
# @param tr_dataset [String] The dataset id to use for the request
|
1030
1040
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1031
1041
|
# @param [Hash] opts the optional parameters
|
1032
|
-
# @
|
1042
|
+
# @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
1043
|
+
# @return [Array<(SearchOverGroupsResponseTypes, Integer, Hash)>] SearchOverGroupsResponseTypes data, response status code and response headers
|
1033
1044
|
def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
|
1034
1045
|
if @api_client.config.debugging
|
1035
1046
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
|
@@ -1058,6 +1069,7 @@ module TrieveRubyClient
|
|
1058
1069
|
header_params['Content-Type'] = content_type
|
1059
1070
|
end
|
1060
1071
|
header_params[:'TR-Dataset'] = tr_dataset
|
1072
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
1061
1073
|
|
1062
1074
|
# form parameters
|
1063
1075
|
form_params = opts[:form_params] || {}
|
@@ -1066,7 +1078,7 @@ module TrieveRubyClient
|
|
1066
1078
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
|
1067
1079
|
|
1068
1080
|
# return_type
|
1069
|
-
return_type = opts[:debug_return_type] || '
|
1081
|
+
return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseTypes'
|
1070
1082
|
|
1071
1083
|
# auth_names
|
1072
1084
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1089,22 +1101,24 @@ module TrieveRubyClient
|
|
1089
1101
|
end
|
1090
1102
|
|
1091
1103
|
# Search Within Group
|
1092
|
-
#
|
1104
|
+
# 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.
|
1093
1105
|
# @param tr_dataset [String] The dataset id to use for the request
|
1094
1106
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1095
1107
|
# @param [Hash] opts the optional parameters
|
1096
|
-
# @
|
1108
|
+
# @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
1109
|
+
# @return [SearchGroupResponseTypes]
|
1097
1110
|
def search_within_group(tr_dataset, search_within_group_data, opts = {})
|
1098
1111
|
data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1099
1112
|
data
|
1100
1113
|
end
|
1101
1114
|
|
1102
1115
|
# Search Within Group
|
1103
|
-
#
|
1116
|
+
# 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.
|
1104
1117
|
# @param tr_dataset [String] The dataset id to use for the request
|
1105
1118
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1106
1119
|
# @param [Hash] opts the optional parameters
|
1107
|
-
# @
|
1120
|
+
# @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
|
1121
|
+
# @return [Array<(SearchGroupResponseTypes, Integer, Hash)>] SearchGroupResponseTypes data, response status code and response headers
|
1108
1122
|
def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
|
1109
1123
|
if @api_client.config.debugging
|
1110
1124
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
|
@@ -1133,6 +1147,7 @@ module TrieveRubyClient
|
|
1133
1147
|
header_params['Content-Type'] = content_type
|
1134
1148
|
end
|
1135
1149
|
header_params[:'TR-Dataset'] = tr_dataset
|
1150
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
1136
1151
|
|
1137
1152
|
# form parameters
|
1138
1153
|
form_params = opts[:form_params] || {}
|
@@ -1141,7 +1156,7 @@ module TrieveRubyClient
|
|
1141
1156
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
|
1142
1157
|
|
1143
1158
|
# return_type
|
1144
|
-
return_type = opts[:debug_return_type] || '
|
1159
|
+
return_type = opts[:debug_return_type] || 'SearchGroupResponseTypes'
|
1145
1160
|
|
1146
1161
|
# auth_names
|
1147
1162
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1164,7 +1179,7 @@ module TrieveRubyClient
|
|
1164
1179
|
end
|
1165
1180
|
|
1166
1181
|
# Update Group
|
1167
|
-
# Update
|
1182
|
+
# 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.
|
1168
1183
|
# @param tr_dataset [String] The dataset id to use for the request
|
1169
1184
|
# @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
|
1170
1185
|
# @param [Hash] opts the optional parameters
|
@@ -1175,7 +1190,7 @@ module TrieveRubyClient
|
|
1175
1190
|
end
|
1176
1191
|
|
1177
1192
|
# Update Group
|
1178
|
-
# Update
|
1193
|
+
# 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.
|
1179
1194
|
# @param tr_dataset [String] The dataset id to use for the request
|
1180
1195
|
# @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
|
1181
1196
|
# @param [Hash] opts the optional parameters
|
@@ -1239,7 +1254,7 @@ module TrieveRubyClient
|
|
1239
1254
|
end
|
1240
1255
|
|
1241
1256
|
# Update Group by Tracking ID
|
1242
|
-
# Update
|
1257
|
+
# 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.
|
1243
1258
|
# @param tr_dataset [String] The dataset id to use for the request
|
1244
1259
|
# @param tracking_id [String] Tracking id of the chunk_group to update
|
1245
1260
|
# @param update_group_by_tracking_id_req_payload [UpdateGroupByTrackingIDReqPayload] JSON request payload to update a chunkGroup
|
@@ -1251,7 +1266,7 @@ module TrieveRubyClient
|
|
1251
1266
|
end
|
1252
1267
|
|
1253
1268
|
# Update Group by Tracking ID
|
1254
|
-
# Update
|
1269
|
+
# 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.
|
1255
1270
|
# @param tr_dataset [String] The dataset id to use for the request
|
1256
1271
|
# @param tracking_id [String] Tracking id of the chunk_group to update
|
1257
1272
|
# @param update_group_by_tracking_id_req_payload [UpdateGroupByTrackingIDReqPayload] JSON request payload to update a chunkGroup
|