trieve_ruby_client 0.8.2 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GENERATE_COMMAND.txt +2 -0
- data/README.md +153 -41
- data/docs/APIVersion.md +15 -0
- data/docs/AnalyticsApi.md +303 -0
- data/docs/ApiKeyRespBody.md +32 -0
- data/docs/AuthApi.md +4 -4
- data/docs/AutocompleteData.md +42 -0
- data/docs/AutocompleteReqPayload.md +54 -0
- data/docs/BookmarkGroupResponse.md +49 -0
- data/docs/BookmarkGroupResult.md +1 -1
- data/docs/BoostPhrase.md +20 -0
- data/docs/ChatMessageProxy.md +1 -1
- data/docs/ChunkApi.md +269 -93
- data/docs/ChunkData.md +3 -1
- data/docs/ChunkFilter.md +5 -3
- data/docs/ChunkGroup.md +1 -1
- data/docs/ChunkGroupAndFileId.md +36 -0
- data/docs/ChunkGroupApi.md +136 -114
- data/docs/ChunkMetadata.md +6 -2
- data/docs/ChunkMetadataStringTagSet.md +46 -0
- data/docs/ChunkMetadataTypes.md +51 -0
- data/docs/ChunkMetadataWithScore.md +1 -1
- data/docs/ChunkReqPayload.md +50 -0
- data/docs/ChunkReturnTypes.md +49 -0
- data/docs/ClientDatasetConfiguration.md +0 -2
- data/docs/ClusterAnalytics.md +63 -0
- data/docs/ClusterAnalyticsFilter.md +18 -0
- data/docs/ClusterAnalyticsResponse.md +49 -0
- data/docs/ClusterQueries.md +22 -0
- data/docs/ClusterTopics.md +20 -0
- data/docs/ConditionType.md +49 -0
- data/docs/ContentChunkMetadata.md +32 -0
- data/docs/CountChunkQueryResponseBody.md +18 -0
- data/docs/CountChunksReqPayload.md +26 -0
- data/docs/CountQueries.md +20 -0
- data/docs/CreateChunkGroupReqPayload.md +28 -0
- data/docs/CreateChunkReqPayloadEnum.md +49 -0
- data/docs/CreateDatasetRequest.md +2 -2
- data/docs/CreateMessageData.md +2 -2
- data/docs/CreateMessageReqPayload.md +52 -0
- data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
- data/docs/CreateTopicReqPayload.md +22 -0
- data/docs/Dataset.md +2 -2
- data/docs/DatasetAnalytics.md +28 -0
- data/docs/DatasetApi.md +184 -32
- data/docs/DatasetDTO.md +0 -2
- data/docs/DateRange.md +24 -0
- data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
- data/docs/DistancePhrase.md +20 -0
- data/docs/EditMessageReqPayload.md +54 -0
- data/docs/Event.md +3 -5
- data/docs/EventTypeRequest.md +15 -0
- data/docs/EventsApi.md +1 -1
- data/docs/FieldCondition.md +2 -0
- data/docs/File.md +1 -1
- data/docs/FileApi.md +10 -10
- data/docs/GenerateChunksRequest.md +13 -1
- data/docs/GeoInfoWithBias.md +20 -0
- data/docs/GetChunksForGroupsResponse.md +22 -0
- data/docs/GetDatasetsPagination.md +20 -0
- data/docs/GetEventsData.md +1 -1
- data/docs/Granularity.md +15 -0
- data/docs/GroupData.md +1 -1
- data/docs/GroupScoreChunk.md +14 -0
- data/docs/GroupsBookmarkQueryResult.md +22 -0
- data/docs/HasIDCondition.md +20 -0
- data/docs/HeadQueries.md +20 -0
- data/docs/HeadQueries1.md +22 -0
- data/docs/HeadQueryResponse.md +18 -0
- data/docs/HealthApi.md +1 -1
- data/docs/InvitationApi.md +1 -1
- data/docs/LatencyGraph.md +22 -0
- data/docs/LatencyGraphResponse.md +18 -0
- data/docs/LowConfidenceQueries.md +24 -0
- data/docs/LowConfidenceRecommendations.md +24 -0
- data/docs/MatchCondition.md +3 -1
- data/docs/MessageApi.md +43 -43
- data/docs/MetricsApi.md +76 -0
- data/docs/NewChunkMetadataTypes.md +51 -0
- data/docs/NoResultQueries.md +22 -0
- data/docs/Organization.md +2 -0
- data/docs/OrganizationApi.md +27 -28
- data/docs/QueryCountResponse.md +18 -0
- data/docs/QueryDetails.md +20 -0
- data/docs/RAGAnalytics.md +63 -0
- data/docs/RAGAnalyticsFilter.md +20 -0
- data/docs/RAGAnalyticsResponse.md +49 -0
- data/docs/RAGQueries.md +26 -0
- data/docs/RAGUsage.md +20 -0
- data/docs/RAGUsageResponse.md +18 -0
- data/docs/RPSGraph.md +22 -0
- data/docs/RPSGraphResponse.md +18 -0
- data/docs/RagQueryEvent.md +30 -0
- data/docs/RagQueryResponse.md +18 -0
- data/docs/RagTypes.md +15 -0
- data/docs/RangeCondition.md +1 -3
- data/docs/RecommendChunksRequest.md +2 -2
- data/docs/RecommendChunksResponseBody.md +18 -0
- data/docs/RecommendGroupChunksRequest.md +2 -2
- data/docs/RecommendGroupsResponse.md +49 -0
- data/docs/RecommendGroupsResponseBody.md +18 -0
- data/docs/RecommendResponseTypes.md +49 -0
- data/docs/RecommendType.md +15 -0
- data/docs/RecommendationAnalytics.md +63 -0
- data/docs/RecommendationAnalyticsFilter.md +20 -0
- data/docs/RecommendationAnalyticsResponse.md +47 -0
- data/docs/RecommendationEvent.md +38 -0
- data/docs/RecommendationQueries.md +26 -0
- data/docs/RecommendationStrategy.md +15 -0
- data/docs/RecommendationType.md +15 -0
- data/docs/RecommendationsEventResponse.md +18 -0
- data/docs/RegenerateMessageReqPayload.md +48 -0
- data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
- data/docs/RoleProxy.md +15 -0
- data/docs/ScoreChunk.md +22 -0
- data/docs/ScoreChunkDTO.md +3 -1
- data/docs/SearchAnalytics.md +77 -0
- data/docs/SearchAnalyticsFilter.md +22 -0
- data/docs/SearchAnalyticsResponse.md +59 -0
- data/docs/SearchChunkData.md +9 -3
- data/docs/SearchChunksReqPayload.md +56 -0
- data/docs/SearchClusterResponse.md +18 -0
- data/docs/SearchClusterTopics.md +28 -0
- data/docs/SearchGroupResponseTypes.md +49 -0
- data/docs/SearchLatencyGraph.md +20 -0
- data/docs/SearchMethod.md +15 -0
- data/docs/SearchMetrics.md +20 -0
- data/docs/SearchOverGroupsData.md +12 -6
- data/docs/SearchOverGroupsResponseBody.md +4 -4
- data/docs/SearchOverGroupsResponseTypes.md +4 -4
- data/docs/SearchOverGroupsResults.md +6 -4
- data/docs/SearchQueries.md +26 -0
- data/docs/SearchQueryEvent.md +34 -0
- data/docs/SearchQueryResponse.md +18 -0
- data/docs/SearchRPSGraph.md +20 -0
- data/docs/SearchResponseBody.md +20 -0
- data/docs/SearchResponseTypes.md +49 -0
- data/docs/SearchResultType.md +49 -0
- data/docs/SearchType.md +15 -0
- data/docs/SearchTypeCount.md +22 -0
- data/docs/SearchWithinGroupData.md +18 -4
- data/docs/SearchWithinGroupResponseBody.md +20 -0
- data/docs/SearchWithinGroupResults.md +1 -1
- data/docs/SetUserApiKeyRequest.md +4 -0
- data/docs/SlimChunkMetadata.md +5 -1
- data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
- data/docs/SlimChunkMetadataWithScore.md +1 -1
- data/docs/SortBy.md +15 -0
- data/docs/SortOrder.md +15 -0
- data/docs/StripeApi.md +134 -4
- data/docs/StripeInvoice.md +28 -0
- data/docs/SuggestedQueriesReqPayload.md +18 -0
- data/docs/TopicApi.md +16 -16
- data/docs/UpdateChunkData.md +2 -0
- data/docs/UpdateChunkGroupData.md +3 -1
- data/docs/UpdateChunkReqPayload.md +48 -0
- data/docs/UpdateDatasetRequest.md +2 -0
- data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
- data/docs/UpdateTopicReqPayload.md +20 -0
- data/docs/UpdateUserOrgRoleData.md +1 -1
- data/docs/UploadFileReqPayload.md +40 -0
- data/docs/UserApi.md +9 -10
- data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
- data/lib/trieve_ruby_client/api/chunk_api.rb +274 -103
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +161 -139
- data/lib/trieve_ruby_client/api/dataset_api.rb +183 -38
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +18 -18
- data/lib/trieve_ruby_client/api/health_api.rb +3 -3
- data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
- data/lib/trieve_ruby_client/api/message_api.rb +52 -52
- data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +33 -33
- data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
- data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
- data/lib/trieve_ruby_client/api/user_api.rb +12 -12
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +8 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
- data/lib/trieve_ruby_client/models/api_version.rb +40 -0
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
- data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +509 -0
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
- data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
- data/lib/trieve_ruby_client/models/chunk_data.rb +16 -9
- data/lib/trieve_ruby_client/models/chunk_filter.rb +16 -5
- data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +35 -5
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +393 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +397 -0
- data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
- data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
- data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
- data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +305 -0
- data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
- data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
- data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
- data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +469 -0
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
- data/lib/trieve_ruby_client/models/dataset.rb +18 -14
- data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/date_range.rb +245 -0
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +486 -0
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +12 -24
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
- data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
- data/lib/trieve_ruby_client/models/file.rb +5 -3
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +89 -6
- data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
- data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
- data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
- data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
- data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/granularity.rb +42 -0
- data/lib/trieve_ruby_client/models/group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
- data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
- data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
- data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
- data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
- data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
- data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
- data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
- data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
- data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
- data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
- data/lib/trieve_ruby_client/models/organization.rb +18 -2
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
- data/lib/trieve_ruby_client/models/query_details.rb +271 -0
- data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
- data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
- data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
- data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
- data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
- data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +441 -0
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
- data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
- data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
- data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
- data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +40 -5
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +535 -0
- data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
- data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_method.rb +42 -0
- data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +117 -18
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
- data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
- data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
- data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_type.rb +42 -0
- data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +151 -7
- data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +31 -3
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
- data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
- data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +386 -0
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +110 -24
- data/openapi-generator.yaml +2 -2
- data/openapi.json +4491 -1230
- data/spec/api/analytics_api_spec.rb +87 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/models/api_key_resp_body_spec.rb +78 -0
- data/spec/models/api_version_spec.rb +30 -0
- data/spec/models/autocomplete_data_spec.rb +108 -0
- data/spec/models/autocomplete_req_payload_spec.rb +132 -0
- data/spec/models/bookmark_group_response_spec.rb +32 -0
- data/spec/models/boost_phrase_spec.rb +42 -0
- data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
- data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
- data/spec/models/chunk_metadata_types_spec.rb +32 -0
- data/spec/models/chunk_req_payload_spec.rb +132 -0
- data/spec/models/chunk_return_types_spec.rb +32 -0
- data/spec/models/cluster_analytics_filter_spec.rb +36 -0
- data/spec/models/cluster_analytics_response_spec.rb +32 -0
- data/spec/models/cluster_analytics_spec.rb +38 -0
- data/spec/models/cluster_queries_spec.rb +52 -0
- data/spec/models/cluster_topics_spec.rb +46 -0
- data/spec/models/condition_type_spec.rb +32 -0
- data/spec/models/content_chunk_metadata_spec.rb +72 -0
- data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
- data/spec/models/count_chunks_req_payload_spec.rb +60 -0
- data/spec/models/count_queries_spec.rb +46 -0
- data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
- data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
- data/spec/models/create_message_req_payload_spec.rb +108 -0
- data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
- data/spec/models/create_topic_req_payload_spec.rb +48 -0
- data/spec/models/dataset_analytics_spec.rb +66 -0
- data/spec/models/date_range_spec.rb +54 -0
- data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
- data/spec/models/distance_phrase_spec.rb +42 -0
- data/spec/models/edit_message_req_payload_spec.rb +114 -0
- data/spec/models/event_type_request_spec.rb +30 -0
- data/spec/models/geo_info_with_bias_spec.rb +42 -0
- data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
- data/spec/models/get_datasets_pagination_spec.rb +42 -0
- data/spec/models/granularity_spec.rb +30 -0
- data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
- data/spec/models/has_id_condition_spec.rb +42 -0
- data/spec/models/head_queries1_spec.rb +52 -0
- data/spec/models/head_queries_spec.rb +42 -0
- data/spec/models/head_query_response_spec.rb +36 -0
- data/spec/models/latency_graph_response_spec.rb +36 -0
- data/spec/models/latency_graph_spec.rb +52 -0
- data/spec/models/low_confidence_queries_spec.rb +58 -0
- data/spec/models/low_confidence_recommendations_spec.rb +58 -0
- data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
- data/spec/models/no_result_queries_spec.rb +52 -0
- data/spec/models/query_count_response_spec.rb +36 -0
- data/spec/models/query_details_spec.rb +46 -0
- data/spec/models/rag_analytics_filter_spec.rb +42 -0
- data/spec/models/rag_analytics_response_spec.rb +32 -0
- data/spec/models/rag_analytics_spec.rb +38 -0
- data/spec/models/rag_queries_spec.rb +64 -0
- data/spec/models/rag_query_event_spec.rb +72 -0
- data/spec/models/rag_query_response_spec.rb +36 -0
- data/spec/models/rag_types_spec.rb +30 -0
- data/spec/models/rag_usage_response_spec.rb +36 -0
- data/spec/models/rag_usage_spec.rb +46 -0
- data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_spec.rb +32 -0
- data/spec/models/recommend_response_types_spec.rb +32 -0
- data/spec/models/recommend_type_spec.rb +30 -0
- data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
- data/spec/models/recommendation_analytics_response_spec.rb +32 -0
- data/spec/models/recommendation_analytics_spec.rb +38 -0
- data/spec/models/recommendation_event_spec.rb +96 -0
- data/spec/models/recommendation_queries_spec.rb +64 -0
- data/spec/models/recommendation_strategy_spec.rb +30 -0
- data/spec/models/recommendation_type_spec.rb +30 -0
- data/spec/models/recommendations_event_response_spec.rb +36 -0
- data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
- data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
- data/spec/models/role_proxy_spec.rb +30 -0
- data/spec/models/rps_graph_response_spec.rb +36 -0
- data/spec/models/rps_graph_spec.rb +52 -0
- data/spec/models/score_chunk_spec.rb +48 -0
- data/spec/models/search_analytics_filter_spec.rb +48 -0
- data/spec/models/search_analytics_response_spec.rb +32 -0
- data/spec/models/search_analytics_spec.rb +38 -0
- data/spec/models/search_chunks_req_payload_spec.rb +144 -0
- data/spec/models/search_cluster_response_spec.rb +36 -0
- data/spec/models/search_cluster_topics_spec.rb +66 -0
- data/spec/models/search_group_response_types_spec.rb +32 -0
- data/spec/models/search_latency_graph_spec.rb +42 -0
- data/spec/models/search_method_spec.rb +30 -0
- data/spec/models/search_metrics_spec.rb +46 -0
- data/spec/models/search_queries_spec.rb +64 -0
- data/spec/models/search_query_event_spec.rb +84 -0
- data/spec/models/search_query_response_spec.rb +36 -0
- data/spec/models/search_response_body_spec.rb +42 -0
- data/spec/models/search_response_types_spec.rb +32 -0
- data/spec/models/search_result_type_spec.rb +32 -0
- data/spec/models/search_rps_graph_spec.rb +42 -0
- data/spec/models/search_type_count_spec.rb +48 -0
- data/spec/models/search_type_spec.rb +30 -0
- data/spec/models/search_within_group_response_body_spec.rb +42 -0
- data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
- data/spec/models/sort_by_spec.rb +30 -0
- data/spec/models/sort_order_spec.rb +30 -0
- data/spec/models/stripe_invoice_spec.rb +66 -0
- data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
- data/spec/models/update_chunk_req_payload_spec.rb +120 -0
- data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
- data/spec/models/update_topic_req_payload_spec.rb +42 -0
- data/spec/models/upload_file_req_payload_spec.rb +102 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client.gemspec +1 -1
- metadata +534 -111
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client-0.6.2.gem +0 -0
- data/trieve_ruby_client-0.6.7.gem +0 -0
- data/trieve_ruby_client-0.6.9.gem +0 -0
- data/trieve_ruby_client-0.7.2.gem +0 -0
- data/trieve_ruby_client-0.7.6.gem +0 -0
- data/trieve_ruby_client-0.8.0.gem +0 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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,23 +182,23 @@ 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
|
-
# @param
|
187
|
+
# @param create_chunk_group_req_payload [CreateChunkGroupReqPayload] JSON request payload to cretea a chunkGroup
|
188
188
|
# @param [Hash] opts the optional parameters
|
189
189
|
# @return [ChunkGroup]
|
190
|
-
def create_chunk_group(tr_dataset,
|
191
|
-
data, _status_code, _headers = create_chunk_group_with_http_info(tr_dataset,
|
190
|
+
def create_chunk_group(tr_dataset, create_chunk_group_req_payload, opts = {})
|
191
|
+
data, _status_code, _headers = create_chunk_group_with_http_info(tr_dataset, create_chunk_group_req_payload, opts)
|
192
192
|
data
|
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
|
-
# @param
|
198
|
+
# @param create_chunk_group_req_payload [CreateChunkGroupReqPayload] JSON request payload to cretea a chunkGroup
|
199
199
|
# @param [Hash] opts the optional parameters
|
200
200
|
# @return [Array<(ChunkGroup, Integer, Hash)>] ChunkGroup data, response status code and response headers
|
201
|
-
def create_chunk_group_with_http_info(tr_dataset,
|
201
|
+
def create_chunk_group_with_http_info(tr_dataset, create_chunk_group_req_payload, opts = {})
|
202
202
|
if @api_client.config.debugging
|
203
203
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.create_chunk_group ...'
|
204
204
|
end
|
@@ -206,9 +206,9 @@ module TrieveRubyClient
|
|
206
206
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
207
207
|
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.create_chunk_group"
|
208
208
|
end
|
209
|
-
# verify the required parameter '
|
210
|
-
if @api_client.config.client_side_validation &&
|
211
|
-
fail ArgumentError, "Missing the required parameter '
|
209
|
+
# verify the required parameter 'create_chunk_group_req_payload' is set
|
210
|
+
if @api_client.config.client_side_validation && create_chunk_group_req_payload.nil?
|
211
|
+
fail ArgumentError, "Missing the required parameter 'create_chunk_group_req_payload' when calling ChunkGroupApi.create_chunk_group"
|
212
212
|
end
|
213
213
|
# resource path
|
214
214
|
local_var_path = '/api/chunk_group'
|
@@ -231,7 +231,7 @@ module TrieveRubyClient
|
|
231
231
|
form_params = opts[:form_params] || {}
|
232
232
|
|
233
233
|
# http body (model)
|
234
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
234
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_group_req_payload)
|
235
235
|
|
236
236
|
# return_type
|
237
237
|
return_type = opts[:debug_return_type] || 'ChunkGroup'
|
@@ -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,23 +334,25 @@ 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
|
+
# @param delete_chunks [Boolean] Delete the chunks within the group
|
340
341
|
# @param [Hash] opts the optional parameters
|
341
342
|
# @return [nil]
|
342
|
-
def delete_group_by_tracking_id(tr_dataset, tracking_id, opts = {})
|
343
|
-
delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
|
343
|
+
def delete_group_by_tracking_id(tr_dataset, tracking_id, delete_chunks, opts = {})
|
344
|
+
delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, delete_chunks, opts)
|
344
345
|
nil
|
345
346
|
end
|
346
347
|
|
347
348
|
# Delete Group by Tracking ID
|
348
|
-
# 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.
|
349
350
|
# @param tr_dataset [String] The dataset id to use for the request
|
350
351
|
# @param tracking_id [String] Tracking id of the chunk_group to delete
|
352
|
+
# @param delete_chunks [Boolean] Delete the chunks within the group
|
351
353
|
# @param [Hash] opts the optional parameters
|
352
354
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
353
|
-
def delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
|
355
|
+
def delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, delete_chunks, opts = {})
|
354
356
|
if @api_client.config.debugging
|
355
357
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.delete_group_by_tracking_id ...'
|
356
358
|
end
|
@@ -362,11 +364,16 @@ module TrieveRubyClient
|
|
362
364
|
if @api_client.config.client_side_validation && tracking_id.nil?
|
363
365
|
fail ArgumentError, "Missing the required parameter 'tracking_id' when calling ChunkGroupApi.delete_group_by_tracking_id"
|
364
366
|
end
|
367
|
+
# verify the required parameter 'delete_chunks' is set
|
368
|
+
if @api_client.config.client_side_validation && delete_chunks.nil?
|
369
|
+
fail ArgumentError, "Missing the required parameter 'delete_chunks' when calling ChunkGroupApi.delete_group_by_tracking_id"
|
370
|
+
end
|
365
371
|
# resource path
|
366
372
|
local_var_path = '/api/chunk_group/tracking_id/{tracking_id}'.sub('{' + 'tracking_id' + '}', CGI.escape(tracking_id.to_s))
|
367
373
|
|
368
374
|
# query parameters
|
369
375
|
query_params = opts[:query_params] || {}
|
376
|
+
query_params[:'delete_chunks'] = delete_chunks
|
370
377
|
|
371
378
|
# header parameters
|
372
379
|
header_params = opts[:header_params] || {}
|
@@ -404,22 +411,22 @@ module TrieveRubyClient
|
|
404
411
|
end
|
405
412
|
|
406
413
|
# Get Group
|
407
|
-
#
|
414
|
+
# Fetch the group with the given id. get_group
|
408
415
|
# @param tr_dataset [String] The dataset id to use for the request
|
409
416
|
# @param group_id [String] Id of the group you want to fetch.
|
410
417
|
# @param [Hash] opts the optional parameters
|
411
|
-
# @return [
|
418
|
+
# @return [ChunkGroupAndFileId]
|
412
419
|
def get_chunk_group(tr_dataset, group_id, opts = {})
|
413
420
|
data, _status_code, _headers = get_chunk_group_with_http_info(tr_dataset, group_id, opts)
|
414
421
|
data
|
415
422
|
end
|
416
423
|
|
417
424
|
# Get Group
|
418
|
-
#
|
425
|
+
# Fetch the group with the given id. get_group
|
419
426
|
# @param tr_dataset [String] The dataset id to use for the request
|
420
427
|
# @param group_id [String] Id of the group you want to fetch.
|
421
428
|
# @param [Hash] opts the optional parameters
|
422
|
-
# @return [Array<(
|
429
|
+
# @return [Array<(ChunkGroupAndFileId, Integer, Hash)>] ChunkGroupAndFileId data, response status code and response headers
|
423
430
|
def get_chunk_group_with_http_info(tr_dataset, group_id, opts = {})
|
424
431
|
if @api_client.config.debugging
|
425
432
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunk_group ...'
|
@@ -451,7 +458,7 @@ module TrieveRubyClient
|
|
451
458
|
post_body = opts[:debug_body]
|
452
459
|
|
453
460
|
# return_type
|
454
|
-
return_type = opts[:debug_return_type] || '
|
461
|
+
return_type = opts[:debug_return_type] || 'ChunkGroupAndFileId'
|
455
462
|
|
456
463
|
# auth_names
|
457
464
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -474,24 +481,26 @@ module TrieveRubyClient
|
|
474
481
|
end
|
475
482
|
|
476
483
|
# Get Chunks in Group
|
477
|
-
#
|
484
|
+
# Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
478
485
|
# @param tr_dataset [String] The dataset id to use for the request
|
479
486
|
# @param group_id [String] Id of the group you want to fetch.
|
480
487
|
# @param page [Integer] The page of chunks to get from the group
|
481
488
|
# @param [Hash] opts the optional parameters
|
482
|
-
# @
|
489
|
+
# @option opts [APIVersion] :x_api_version The version of the API to use for the request
|
490
|
+
# @return [BookmarkGroupResponse]
|
483
491
|
def get_chunks_in_group(tr_dataset, group_id, page, opts = {})
|
484
492
|
data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts)
|
485
493
|
data
|
486
494
|
end
|
487
495
|
|
488
496
|
# Get Chunks in Group
|
489
|
-
#
|
497
|
+
# Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
|
490
498
|
# @param tr_dataset [String] The dataset id to use for the request
|
491
499
|
# @param group_id [String] Id of the group you want to fetch.
|
492
500
|
# @param page [Integer] The page of chunks to get from the group
|
493
501
|
# @param [Hash] opts the optional parameters
|
494
|
-
# @
|
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
|
495
504
|
def get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts = {})
|
496
505
|
if @api_client.config.debugging
|
497
506
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunks_in_group ...'
|
@@ -519,6 +528,7 @@ module TrieveRubyClient
|
|
519
528
|
# HTTP header 'Accept' (if needed)
|
520
529
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
521
530
|
header_params[:'TR-Dataset'] = tr_dataset
|
531
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
522
532
|
|
523
533
|
# form parameters
|
524
534
|
form_params = opts[:form_params] || {}
|
@@ -527,7 +537,7 @@ module TrieveRubyClient
|
|
527
537
|
post_body = opts[:debug_body]
|
528
538
|
|
529
539
|
# return_type
|
530
|
-
return_type = opts[:debug_return_type] || '
|
540
|
+
return_type = opts[:debug_return_type] || 'BookmarkGroupResponse'
|
531
541
|
|
532
542
|
# auth_names
|
533
543
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -550,24 +560,26 @@ module TrieveRubyClient
|
|
550
560
|
end
|
551
561
|
|
552
562
|
# Get Chunks in Group by Tracking ID
|
553
|
-
#
|
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.
|
554
564
|
# @param tr_dataset [String] The dataset id to use for the request
|
555
565
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
556
566
|
# @param page [Integer] The page of chunks to get from the group
|
557
567
|
# @param [Hash] opts the optional parameters
|
558
|
-
# @
|
568
|
+
# @option opts [APIVersion] :x_api_version The version of the API to use for the request
|
569
|
+
# @return [BookmarkGroupResponse]
|
559
570
|
def get_chunks_in_group_by_tracking_id(tr_dataset, group_tracking_id, page, opts = {})
|
560
571
|
data, _status_code, _headers = get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page, opts)
|
561
572
|
data
|
562
573
|
end
|
563
574
|
|
564
575
|
# Get Chunks in Group by Tracking ID
|
565
|
-
#
|
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.
|
566
577
|
# @param tr_dataset [String] The dataset id to use for the request
|
567
578
|
# @param group_tracking_id [String] The id of the group to get the chunks from
|
568
579
|
# @param page [Integer] The page of chunks to get from the group
|
569
580
|
# @param [Hash] opts the optional parameters
|
570
|
-
# @
|
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
|
571
583
|
def get_chunks_in_group_by_tracking_id_with_http_info(tr_dataset, group_tracking_id, page, opts = {})
|
572
584
|
if @api_client.config.debugging
|
573
585
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunks_in_group_by_tracking_id ...'
|
@@ -599,6 +611,7 @@ module TrieveRubyClient
|
|
599
611
|
# HTTP header 'Accept' (if needed)
|
600
612
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
601
613
|
header_params[:'TR-Dataset'] = tr_dataset
|
614
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
602
615
|
|
603
616
|
# form parameters
|
604
617
|
form_params = opts[:form_params] || {}
|
@@ -607,7 +620,7 @@ module TrieveRubyClient
|
|
607
620
|
post_body = opts[:debug_body]
|
608
621
|
|
609
622
|
# return_type
|
610
|
-
return_type = opts[:debug_return_type] || '
|
623
|
+
return_type = opts[:debug_return_type] || 'BookmarkGroupResponse'
|
611
624
|
|
612
625
|
# auth_names
|
613
626
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -630,22 +643,22 @@ module TrieveRubyClient
|
|
630
643
|
end
|
631
644
|
|
632
645
|
# Get Group by Tracking ID
|
633
|
-
#
|
646
|
+
# Fetch the group with the given tracking id. get_group_by_tracking_id
|
634
647
|
# @param tr_dataset [String] The dataset id to use for the request
|
635
648
|
# @param tracking_id [String] The tracking id of the group to fetch.
|
636
649
|
# @param [Hash] opts the optional parameters
|
637
|
-
# @return [
|
650
|
+
# @return [ChunkGroupAndFileId]
|
638
651
|
def get_group_by_tracking_id(tr_dataset, tracking_id, opts = {})
|
639
652
|
data, _status_code, _headers = get_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
|
640
653
|
data
|
641
654
|
end
|
642
655
|
|
643
656
|
# Get Group by Tracking ID
|
644
|
-
#
|
657
|
+
# Fetch the group with the given tracking id. get_group_by_tracking_id
|
645
658
|
# @param tr_dataset [String] The dataset id to use for the request
|
646
659
|
# @param tracking_id [String] The tracking id of the group to fetch.
|
647
660
|
# @param [Hash] opts the optional parameters
|
648
|
-
# @return [Array<(
|
661
|
+
# @return [Array<(ChunkGroupAndFileId, Integer, Hash)>] ChunkGroupAndFileId data, response status code and response headers
|
649
662
|
def get_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
|
650
663
|
if @api_client.config.debugging
|
651
664
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_group_by_tracking_id ...'
|
@@ -677,7 +690,7 @@ module TrieveRubyClient
|
|
677
690
|
post_body = opts[:debug_body]
|
678
691
|
|
679
692
|
# return_type
|
680
|
-
return_type = opts[:debug_return_type] || '
|
693
|
+
return_type = opts[:debug_return_type] || 'ChunkGroupAndFileId'
|
681
694
|
|
682
695
|
# auth_names
|
683
696
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -700,22 +713,22 @@ module TrieveRubyClient
|
|
700
713
|
end
|
701
714
|
|
702
715
|
# Get Groups for Chunks
|
703
|
-
#
|
716
|
+
# Route to get the groups that a chunk is in.
|
704
717
|
# @param tr_dataset [String] The dataset id to use for the request
|
705
718
|
# @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
|
706
719
|
# @param [Hash] opts the optional parameters
|
707
|
-
# @return [Array<
|
720
|
+
# @return [Array<BookmarkGroupResponse>]
|
708
721
|
def get_groups_chunk_is_in(tr_dataset, get_groups_for_chunks_data, opts = {})
|
709
722
|
data, _status_code, _headers = get_groups_chunk_is_in_with_http_info(tr_dataset, get_groups_for_chunks_data, opts)
|
710
723
|
data
|
711
724
|
end
|
712
725
|
|
713
726
|
# Get Groups for Chunks
|
714
|
-
#
|
727
|
+
# Route to get the groups that a chunk is in.
|
715
728
|
# @param tr_dataset [String] The dataset id to use for the request
|
716
729
|
# @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
|
717
730
|
# @param [Hash] opts the optional parameters
|
718
|
-
# @return [Array<(Array<
|
731
|
+
# @return [Array<(Array<BookmarkGroupResponse>, Integer, Hash)>] Array<BookmarkGroupResponse> data, response status code and response headers
|
719
732
|
def get_groups_chunk_is_in_with_http_info(tr_dataset, get_groups_for_chunks_data, opts = {})
|
720
733
|
if @api_client.config.debugging
|
721
734
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_groups_chunk_is_in ...'
|
@@ -752,7 +765,7 @@ module TrieveRubyClient
|
|
752
765
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_groups_for_chunks_data)
|
753
766
|
|
754
767
|
# return_type
|
755
|
-
return_type = opts[:debug_return_type] || 'Array<
|
768
|
+
return_type = opts[:debug_return_type] || 'Array<BookmarkGroupResponse>'
|
756
769
|
|
757
770
|
# auth_names
|
758
771
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -774,37 +787,43 @@ module TrieveRubyClient
|
|
774
787
|
return data, status_code, headers
|
775
788
|
end
|
776
789
|
|
777
|
-
# Get
|
778
|
-
#
|
790
|
+
# Get Groups for Dataset
|
791
|
+
# Fetch the groups which belong to a dataset specified by its id.
|
779
792
|
# @param tr_dataset [String] The dataset id to use for the request
|
780
|
-
# @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.
|
781
795
|
# @param [Hash] opts the optional parameters
|
782
|
-
# @return [
|
783
|
-
def
|
784
|
-
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)
|
785
799
|
data
|
786
800
|
end
|
787
801
|
|
788
|
-
# Get
|
789
|
-
#
|
802
|
+
# Get Groups for Dataset
|
803
|
+
# Fetch the groups which belong to a dataset specified by its id.
|
790
804
|
# @param tr_dataset [String] The dataset id to use for the request
|
791
|
-
# @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.
|
792
807
|
# @param [Hash] opts the optional parameters
|
793
|
-
# @return [Array<(
|
794
|
-
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 = {})
|
795
810
|
if @api_client.config.debugging
|
796
|
-
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.
|
811
|
+
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_groups_for_dataset ...'
|
797
812
|
end
|
798
813
|
# verify the required parameter 'tr_dataset' is set
|
799
814
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
800
|
-
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"
|
801
816
|
end
|
802
|
-
# verify the required parameter '
|
803
|
-
if @api_client.config.client_side_validation &&
|
804
|
-
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"
|
805
824
|
end
|
806
825
|
# resource path
|
807
|
-
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))
|
808
827
|
|
809
828
|
# query parameters
|
810
829
|
query_params = opts[:query_params] || {}
|
@@ -813,27 +832,22 @@ module TrieveRubyClient
|
|
813
832
|
header_params = opts[:header_params] || {}
|
814
833
|
# HTTP header 'Accept' (if needed)
|
815
834
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
816
|
-
# HTTP header 'Content-Type'
|
817
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
818
|
-
if !content_type.nil?
|
819
|
-
header_params['Content-Type'] = content_type
|
820
|
-
end
|
821
835
|
header_params[:'TR-Dataset'] = tr_dataset
|
822
836
|
|
823
837
|
# form parameters
|
824
838
|
form_params = opts[:form_params] || {}
|
825
839
|
|
826
840
|
# http body (model)
|
827
|
-
post_body = opts[:debug_body]
|
841
|
+
post_body = opts[:debug_body]
|
828
842
|
|
829
843
|
# return_type
|
830
|
-
return_type = opts[:debug_return_type] || '
|
844
|
+
return_type = opts[:debug_return_type] || 'GroupData'
|
831
845
|
|
832
846
|
# auth_names
|
833
847
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
834
848
|
|
835
849
|
new_options = opts.merge(
|
836
|
-
:operation => :"ChunkGroupApi.
|
850
|
+
:operation => :"ChunkGroupApi.get_groups_for_dataset",
|
837
851
|
:header_params => header_params,
|
838
852
|
:query_params => query_params,
|
839
853
|
:form_params => form_params,
|
@@ -842,50 +856,46 @@ module TrieveRubyClient
|
|
842
856
|
:return_type => return_type
|
843
857
|
)
|
844
858
|
|
845
|
-
data, status_code, headers = @api_client.call_api(:
|
859
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
846
860
|
if @api_client.config.debugging
|
847
|
-
@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}"
|
848
862
|
end
|
849
863
|
return data, status_code, headers
|
850
864
|
end
|
851
865
|
|
852
|
-
# Get Groups
|
853
|
-
#
|
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.
|
854
868
|
# @param tr_dataset [String] The dataset id to use for the request
|
855
|
-
# @param
|
856
|
-
# @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
|
857
870
|
# @param [Hash] opts the optional parameters
|
858
|
-
# @
|
859
|
-
|
860
|
-
|
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)
|
861
875
|
data
|
862
876
|
end
|
863
877
|
|
864
|
-
# Get Groups
|
865
|
-
#
|
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.
|
866
880
|
# @param tr_dataset [String] The dataset id to use for the request
|
867
|
-
# @param
|
868
|
-
# @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
|
869
882
|
# @param [Hash] opts the optional parameters
|
870
|
-
# @
|
871
|
-
|
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 = {})
|
872
886
|
if @api_client.config.debugging
|
873
|
-
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.
|
887
|
+
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_recommended_groups ...'
|
874
888
|
end
|
875
889
|
# verify the required parameter 'tr_dataset' is set
|
876
890
|
if @api_client.config.client_side_validation && tr_dataset.nil?
|
877
|
-
fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.
|
878
|
-
end
|
879
|
-
# verify the required parameter 'dataset_id' is set
|
880
|
-
if @api_client.config.client_side_validation && dataset_id.nil?
|
881
|
-
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"
|
882
892
|
end
|
883
|
-
# verify the required parameter '
|
884
|
-
if @api_client.config.client_side_validation &&
|
885
|
-
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"
|
886
896
|
end
|
887
897
|
# resource path
|
888
|
-
local_var_path = '/api/
|
898
|
+
local_var_path = '/api/chunk_group/recommend'
|
889
899
|
|
890
900
|
# query parameters
|
891
901
|
query_params = opts[:query_params] || {}
|
@@ -894,22 +904,28 @@ module TrieveRubyClient
|
|
894
904
|
header_params = opts[:header_params] || {}
|
895
905
|
# HTTP header 'Accept' (if needed)
|
896
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
|
897
912
|
header_params[:'TR-Dataset'] = tr_dataset
|
913
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
898
914
|
|
899
915
|
# form parameters
|
900
916
|
form_params = opts[:form_params] || {}
|
901
917
|
|
902
918
|
# http body (model)
|
903
|
-
post_body = opts[:debug_body]
|
919
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_group_chunks_request)
|
904
920
|
|
905
921
|
# return_type
|
906
|
-
return_type = opts[:debug_return_type] || '
|
922
|
+
return_type = opts[:debug_return_type] || 'RecommendGroupsResponse'
|
907
923
|
|
908
924
|
# auth_names
|
909
925
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
910
926
|
|
911
927
|
new_options = opts.merge(
|
912
|
-
:operation => :"ChunkGroupApi.
|
928
|
+
:operation => :"ChunkGroupApi.get_recommended_groups",
|
913
929
|
:header_params => header_params,
|
914
930
|
:query_params => query_params,
|
915
931
|
:form_params => form_params,
|
@@ -918,33 +934,33 @@ module TrieveRubyClient
|
|
918
934
|
:return_type => return_type
|
919
935
|
)
|
920
936
|
|
921
|
-
data, status_code, headers = @api_client.call_api(:
|
937
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
922
938
|
if @api_client.config.debugging
|
923
|
-
@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}"
|
924
940
|
end
|
925
941
|
return data, status_code, headers
|
926
942
|
end
|
927
943
|
|
928
944
|
# Remove Chunk from Group
|
929
|
-
#
|
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.
|
930
946
|
# @param tr_dataset [String] The dataset id to use for the request
|
931
|
-
# @param group_id [String] Id of the group to remove the
|
932
|
-
# @param
|
947
|
+
# @param group_id [String] Id of the group you want to remove the chunk from.
|
948
|
+
# @param remove_chunk_from_group_req_payload [RemoveChunkFromGroupReqPayload] JSON request payload to remove a chunk from a group
|
933
949
|
# @param [Hash] opts the optional parameters
|
934
950
|
# @return [nil]
|
935
|
-
def remove_chunk_from_group(tr_dataset, group_id,
|
936
|
-
remove_chunk_from_group_with_http_info(tr_dataset, group_id,
|
951
|
+
def remove_chunk_from_group(tr_dataset, group_id, remove_chunk_from_group_req_payload, opts = {})
|
952
|
+
remove_chunk_from_group_with_http_info(tr_dataset, group_id, remove_chunk_from_group_req_payload, opts)
|
937
953
|
nil
|
938
954
|
end
|
939
955
|
|
940
956
|
# Remove Chunk from Group
|
941
|
-
#
|
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.
|
942
958
|
# @param tr_dataset [String] The dataset id to use for the request
|
943
|
-
# @param group_id [String] Id of the group to remove the
|
944
|
-
# @param
|
959
|
+
# @param group_id [String] Id of the group you want to remove the chunk from.
|
960
|
+
# @param remove_chunk_from_group_req_payload [RemoveChunkFromGroupReqPayload] JSON request payload to remove a chunk from a group
|
945
961
|
# @param [Hash] opts the optional parameters
|
946
962
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
947
|
-
def remove_chunk_from_group_with_http_info(tr_dataset, group_id,
|
963
|
+
def remove_chunk_from_group_with_http_info(tr_dataset, group_id, remove_chunk_from_group_req_payload, opts = {})
|
948
964
|
if @api_client.config.debugging
|
949
965
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.remove_chunk_from_group ...'
|
950
966
|
end
|
@@ -956,9 +972,9 @@ module TrieveRubyClient
|
|
956
972
|
if @api_client.config.client_side_validation && group_id.nil?
|
957
973
|
fail ArgumentError, "Missing the required parameter 'group_id' when calling ChunkGroupApi.remove_chunk_from_group"
|
958
974
|
end
|
959
|
-
# verify the required parameter '
|
960
|
-
if @api_client.config.client_side_validation &&
|
961
|
-
fail ArgumentError, "Missing the required parameter '
|
975
|
+
# verify the required parameter 'remove_chunk_from_group_req_payload' is set
|
976
|
+
if @api_client.config.client_side_validation && remove_chunk_from_group_req_payload.nil?
|
977
|
+
fail ArgumentError, "Missing the required parameter 'remove_chunk_from_group_req_payload' when calling ChunkGroupApi.remove_chunk_from_group"
|
962
978
|
end
|
963
979
|
# resource path
|
964
980
|
local_var_path = '/api/chunk_group/chunk/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s))
|
@@ -981,7 +997,7 @@ module TrieveRubyClient
|
|
981
997
|
form_params = opts[:form_params] || {}
|
982
998
|
|
983
999
|
# http body (model)
|
984
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
1000
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(remove_chunk_from_group_req_payload)
|
985
1001
|
|
986
1002
|
# return_type
|
987
1003
|
return_type = opts[:debug_return_type]
|
@@ -1007,22 +1023,24 @@ module TrieveRubyClient
|
|
1007
1023
|
end
|
1008
1024
|
|
1009
1025
|
# Search Over Groups
|
1010
|
-
#
|
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.
|
1011
1027
|
# @param tr_dataset [String] The dataset id to use for the request
|
1012
1028
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1013
1029
|
# @param [Hash] opts the optional parameters
|
1014
|
-
# @
|
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]
|
1015
1032
|
def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
|
1016
1033
|
data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
|
1017
1034
|
data
|
1018
1035
|
end
|
1019
1036
|
|
1020
1037
|
# Search Over Groups
|
1021
|
-
#
|
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.
|
1022
1039
|
# @param tr_dataset [String] The dataset id to use for the request
|
1023
1040
|
# @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
|
1024
1041
|
# @param [Hash] opts the optional parameters
|
1025
|
-
# @
|
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
|
1026
1044
|
def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
|
1027
1045
|
if @api_client.config.debugging
|
1028
1046
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
|
@@ -1051,6 +1069,7 @@ module TrieveRubyClient
|
|
1051
1069
|
header_params['Content-Type'] = content_type
|
1052
1070
|
end
|
1053
1071
|
header_params[:'TR-Dataset'] = tr_dataset
|
1072
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
1054
1073
|
|
1055
1074
|
# form parameters
|
1056
1075
|
form_params = opts[:form_params] || {}
|
@@ -1059,7 +1078,7 @@ module TrieveRubyClient
|
|
1059
1078
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
|
1060
1079
|
|
1061
1080
|
# return_type
|
1062
|
-
return_type = opts[:debug_return_type] || '
|
1081
|
+
return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseTypes'
|
1063
1082
|
|
1064
1083
|
# auth_names
|
1065
1084
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1082,22 +1101,24 @@ module TrieveRubyClient
|
|
1082
1101
|
end
|
1083
1102
|
|
1084
1103
|
# Search Within Group
|
1085
|
-
#
|
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.
|
1086
1105
|
# @param tr_dataset [String] The dataset id to use for the request
|
1087
1106
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1088
1107
|
# @param [Hash] opts the optional parameters
|
1089
|
-
# @
|
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]
|
1090
1110
|
def search_within_group(tr_dataset, search_within_group_data, opts = {})
|
1091
1111
|
data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
|
1092
1112
|
data
|
1093
1113
|
end
|
1094
1114
|
|
1095
1115
|
# Search Within Group
|
1096
|
-
#
|
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.
|
1097
1117
|
# @param tr_dataset [String] The dataset id to use for the request
|
1098
1118
|
# @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
|
1099
1119
|
# @param [Hash] opts the optional parameters
|
1100
|
-
# @
|
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
|
1101
1122
|
def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
|
1102
1123
|
if @api_client.config.debugging
|
1103
1124
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
|
@@ -1126,6 +1147,7 @@ module TrieveRubyClient
|
|
1126
1147
|
header_params['Content-Type'] = content_type
|
1127
1148
|
end
|
1128
1149
|
header_params[:'TR-Dataset'] = tr_dataset
|
1150
|
+
header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
|
1129
1151
|
|
1130
1152
|
# form parameters
|
1131
1153
|
form_params = opts[:form_params] || {}
|
@@ -1134,7 +1156,7 @@ module TrieveRubyClient
|
|
1134
1156
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
|
1135
1157
|
|
1136
1158
|
# return_type
|
1137
|
-
return_type = opts[:debug_return_type] || '
|
1159
|
+
return_type = opts[:debug_return_type] || 'SearchGroupResponseTypes'
|
1138
1160
|
|
1139
1161
|
# auth_names
|
1140
1162
|
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
@@ -1157,7 +1179,7 @@ module TrieveRubyClient
|
|
1157
1179
|
end
|
1158
1180
|
|
1159
1181
|
# Update Group
|
1160
|
-
# 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.
|
1161
1183
|
# @param tr_dataset [String] The dataset id to use for the request
|
1162
1184
|
# @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
|
1163
1185
|
# @param [Hash] opts the optional parameters
|
@@ -1168,7 +1190,7 @@ module TrieveRubyClient
|
|
1168
1190
|
end
|
1169
1191
|
|
1170
1192
|
# Update Group
|
1171
|
-
# 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.
|
1172
1194
|
# @param tr_dataset [String] The dataset id to use for the request
|
1173
1195
|
# @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
|
1174
1196
|
# @param [Hash] opts the optional parameters
|
@@ -1232,25 +1254,25 @@ module TrieveRubyClient
|
|
1232
1254
|
end
|
1233
1255
|
|
1234
1256
|
# Update Group by Tracking ID
|
1235
|
-
# 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.
|
1236
1258
|
# @param tr_dataset [String] The dataset id to use for the request
|
1237
1259
|
# @param tracking_id [String] Tracking id of the chunk_group to update
|
1238
|
-
# @param
|
1260
|
+
# @param update_group_by_tracking_id_req_payload [UpdateGroupByTrackingIDReqPayload] JSON request payload to update a chunkGroup
|
1239
1261
|
# @param [Hash] opts the optional parameters
|
1240
1262
|
# @return [nil]
|
1241
|
-
def update_group_by_tracking_id(tr_dataset, tracking_id,
|
1242
|
-
update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id,
|
1263
|
+
def update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload, opts = {})
|
1264
|
+
update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload, opts)
|
1243
1265
|
nil
|
1244
1266
|
end
|
1245
1267
|
|
1246
1268
|
# Update Group by Tracking ID
|
1247
|
-
# 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.
|
1248
1270
|
# @param tr_dataset [String] The dataset id to use for the request
|
1249
1271
|
# @param tracking_id [String] Tracking id of the chunk_group to update
|
1250
|
-
# @param
|
1272
|
+
# @param update_group_by_tracking_id_req_payload [UpdateGroupByTrackingIDReqPayload] JSON request payload to update a chunkGroup
|
1251
1273
|
# @param [Hash] opts the optional parameters
|
1252
1274
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1253
|
-
def update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id,
|
1275
|
+
def update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload, opts = {})
|
1254
1276
|
if @api_client.config.debugging
|
1255
1277
|
@api_client.config.logger.debug 'Calling API: ChunkGroupApi.update_group_by_tracking_id ...'
|
1256
1278
|
end
|
@@ -1262,9 +1284,9 @@ module TrieveRubyClient
|
|
1262
1284
|
if @api_client.config.client_side_validation && tracking_id.nil?
|
1263
1285
|
fail ArgumentError, "Missing the required parameter 'tracking_id' when calling ChunkGroupApi.update_group_by_tracking_id"
|
1264
1286
|
end
|
1265
|
-
# verify the required parameter '
|
1266
|
-
if @api_client.config.client_side_validation &&
|
1267
|
-
fail ArgumentError, "Missing the required parameter '
|
1287
|
+
# verify the required parameter 'update_group_by_tracking_id_req_payload' is set
|
1288
|
+
if @api_client.config.client_side_validation && update_group_by_tracking_id_req_payload.nil?
|
1289
|
+
fail ArgumentError, "Missing the required parameter 'update_group_by_tracking_id_req_payload' when calling ChunkGroupApi.update_group_by_tracking_id"
|
1268
1290
|
end
|
1269
1291
|
# resource path
|
1270
1292
|
local_var_path = '/api/chunk_group/tracking_id/{tracking_id}'.sub('{' + 'tracking_id' + '}', CGI.escape(tracking_id.to_s))
|
@@ -1287,7 +1309,7 @@ module TrieveRubyClient
|
|
1287
1309
|
form_params = opts[:form_params] || {}
|
1288
1310
|
|
1289
1311
|
# http body (model)
|
1290
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
1312
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_group_by_tracking_id_req_payload)
|
1291
1313
|
|
1292
1314
|
# return_type
|
1293
1315
|
return_type = opts[:debug_return_type]
|