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
|
# Cancel Subscription
|
23
|
-
# Cancel
|
23
|
+
# Cancel a subscription by its id
|
24
24
|
# @param tr_organization [String] The organization id to use for the request
|
25
25
|
# @param subscription_id [String] id of the subscription you want to cancel
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Cancel Subscription
|
34
|
-
# Cancel
|
34
|
+
# Cancel a subscription by its id
|
35
35
|
# @param tr_organization [String] The organization id to use for the request
|
36
36
|
# @param subscription_id [String] id of the subscription you want to cancel
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -89,8 +89,71 @@ module TrieveRubyClient
|
|
89
89
|
return data, status_code, headers
|
90
90
|
end
|
91
91
|
|
92
|
+
# Create checkout session setup
|
93
|
+
# Create a checkout session (setup)
|
94
|
+
# @param organization_id [String] The id of the organization to create setup checkout session for.
|
95
|
+
# @param [Hash] opts the optional parameters
|
96
|
+
# @return [CreateSetupCheckoutSessionResPayload]
|
97
|
+
def create_setup_checkout_session(organization_id, opts = {})
|
98
|
+
data, _status_code, _headers = create_setup_checkout_session_with_http_info(organization_id, opts)
|
99
|
+
data
|
100
|
+
end
|
101
|
+
|
102
|
+
# Create checkout session setup
|
103
|
+
# Create a checkout session (setup)
|
104
|
+
# @param organization_id [String] The id of the organization to create setup checkout session for.
|
105
|
+
# @param [Hash] opts the optional parameters
|
106
|
+
# @return [Array<(CreateSetupCheckoutSessionResPayload, Integer, Hash)>] CreateSetupCheckoutSessionResPayload data, response status code and response headers
|
107
|
+
def create_setup_checkout_session_with_http_info(organization_id, opts = {})
|
108
|
+
if @api_client.config.debugging
|
109
|
+
@api_client.config.logger.debug 'Calling API: StripeApi.create_setup_checkout_session ...'
|
110
|
+
end
|
111
|
+
# verify the required parameter 'organization_id' is set
|
112
|
+
if @api_client.config.client_side_validation && organization_id.nil?
|
113
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling StripeApi.create_setup_checkout_session"
|
114
|
+
end
|
115
|
+
# resource path
|
116
|
+
local_var_path = '/api/stripe/checkout/setup/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))
|
117
|
+
|
118
|
+
# query parameters
|
119
|
+
query_params = opts[:query_params] || {}
|
120
|
+
|
121
|
+
# header parameters
|
122
|
+
header_params = opts[:header_params] || {}
|
123
|
+
# HTTP header 'Accept' (if needed)
|
124
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
125
|
+
|
126
|
+
# form parameters
|
127
|
+
form_params = opts[:form_params] || {}
|
128
|
+
|
129
|
+
# http body (model)
|
130
|
+
post_body = opts[:debug_body]
|
131
|
+
|
132
|
+
# return_type
|
133
|
+
return_type = opts[:debug_return_type] || 'CreateSetupCheckoutSessionResPayload'
|
134
|
+
|
135
|
+
# auth_names
|
136
|
+
auth_names = opts[:debug_auth_names] || []
|
137
|
+
|
138
|
+
new_options = opts.merge(
|
139
|
+
:operation => :"StripeApi.create_setup_checkout_session",
|
140
|
+
:header_params => header_params,
|
141
|
+
:query_params => query_params,
|
142
|
+
:form_params => form_params,
|
143
|
+
:body => post_body,
|
144
|
+
:auth_names => auth_names,
|
145
|
+
:return_type => return_type
|
146
|
+
)
|
147
|
+
|
148
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
149
|
+
if @api_client.config.debugging
|
150
|
+
@api_client.config.logger.debug "API called: StripeApi#create_setup_checkout_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
151
|
+
end
|
152
|
+
return data, status_code, headers
|
153
|
+
end
|
154
|
+
|
92
155
|
# Checkout
|
93
|
-
#
|
156
|
+
# Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization
|
94
157
|
# @param plan_id [String] id of the plan you want to subscribe to
|
95
158
|
# @param organization_id [String] id of the organization you want to subscribe to the plan
|
96
159
|
# @param [Hash] opts the optional parameters
|
@@ -101,7 +164,7 @@ module TrieveRubyClient
|
|
101
164
|
end
|
102
165
|
|
103
166
|
# Checkout
|
104
|
-
#
|
167
|
+
# Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization
|
105
168
|
# @param plan_id [String] id of the plan you want to subscribe to
|
106
169
|
# @param organization_id [String] id of the organization you want to subscribe to the plan
|
107
170
|
# @param [Hash] opts the optional parameters
|
@@ -158,8 +221,71 @@ module TrieveRubyClient
|
|
158
221
|
return data, status_code, headers
|
159
222
|
end
|
160
223
|
|
224
|
+
# Get All Invoices
|
225
|
+
# Get a list of all invoices
|
226
|
+
# @param organization_id [String] The id of the organization to get invoices for.
|
227
|
+
# @param [Hash] opts the optional parameters
|
228
|
+
# @return [Array<StripeInvoice>]
|
229
|
+
def get_all_invoices(organization_id, opts = {})
|
230
|
+
data, _status_code, _headers = get_all_invoices_with_http_info(organization_id, opts)
|
231
|
+
data
|
232
|
+
end
|
233
|
+
|
234
|
+
# Get All Invoices
|
235
|
+
# Get a list of all invoices
|
236
|
+
# @param organization_id [String] The id of the organization to get invoices for.
|
237
|
+
# @param [Hash] opts the optional parameters
|
238
|
+
# @return [Array<(Array<StripeInvoice>, Integer, Hash)>] Array<StripeInvoice> data, response status code and response headers
|
239
|
+
def get_all_invoices_with_http_info(organization_id, opts = {})
|
240
|
+
if @api_client.config.debugging
|
241
|
+
@api_client.config.logger.debug 'Calling API: StripeApi.get_all_invoices ...'
|
242
|
+
end
|
243
|
+
# verify the required parameter 'organization_id' is set
|
244
|
+
if @api_client.config.client_side_validation && organization_id.nil?
|
245
|
+
fail ArgumentError, "Missing the required parameter 'organization_id' when calling StripeApi.get_all_invoices"
|
246
|
+
end
|
247
|
+
# resource path
|
248
|
+
local_var_path = '/api/stripe/invoices/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))
|
249
|
+
|
250
|
+
# query parameters
|
251
|
+
query_params = opts[:query_params] || {}
|
252
|
+
|
253
|
+
# header parameters
|
254
|
+
header_params = opts[:header_params] || {}
|
255
|
+
# HTTP header 'Accept' (if needed)
|
256
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
257
|
+
|
258
|
+
# form parameters
|
259
|
+
form_params = opts[:form_params] || {}
|
260
|
+
|
261
|
+
# http body (model)
|
262
|
+
post_body = opts[:debug_body]
|
263
|
+
|
264
|
+
# return_type
|
265
|
+
return_type = opts[:debug_return_type] || 'Array<StripeInvoice>'
|
266
|
+
|
267
|
+
# auth_names
|
268
|
+
auth_names = opts[:debug_auth_names] || []
|
269
|
+
|
270
|
+
new_options = opts.merge(
|
271
|
+
:operation => :"StripeApi.get_all_invoices",
|
272
|
+
:header_params => header_params,
|
273
|
+
:query_params => query_params,
|
274
|
+
:form_params => form_params,
|
275
|
+
:body => post_body,
|
276
|
+
:auth_names => auth_names,
|
277
|
+
:return_type => return_type
|
278
|
+
)
|
279
|
+
|
280
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
281
|
+
if @api_client.config.debugging
|
282
|
+
@api_client.config.logger.debug "API called: StripeApi#get_all_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
283
|
+
end
|
284
|
+
return data, status_code, headers
|
285
|
+
end
|
286
|
+
|
161
287
|
# Get All Plans
|
162
|
-
# Get
|
288
|
+
# Get a list of all plans
|
163
289
|
# @param [Hash] opts the optional parameters
|
164
290
|
# @return [Array<StripePlan>]
|
165
291
|
def get_all_plans(opts = {})
|
@@ -168,7 +294,7 @@ module TrieveRubyClient
|
|
168
294
|
end
|
169
295
|
|
170
296
|
# Get All Plans
|
171
|
-
# Get
|
297
|
+
# Get a list of all plans
|
172
298
|
# @param [Hash] opts the optional parameters
|
173
299
|
# @return [Array<(Array<StripePlan>, Integer, Hash)>] Array<StripePlan> data, response status code and response headers
|
174
300
|
def get_all_plans_with_http_info(opts = {})
|
@@ -216,7 +342,7 @@ module TrieveRubyClient
|
|
216
342
|
end
|
217
343
|
|
218
344
|
# Update Subscription Plan
|
219
|
-
# Update
|
345
|
+
# Update a subscription to a new plan
|
220
346
|
# @param tr_organization [String] The organization id to use for the request
|
221
347
|
# @param subscription_id [String] id of the subscription you want to update
|
222
348
|
# @param plan_id [String] id of the plan you want to subscribe to
|
@@ -228,7 +354,7 @@ module TrieveRubyClient
|
|
228
354
|
end
|
229
355
|
|
230
356
|
# Update Subscription Plan
|
231
|
-
# Update
|
357
|
+
# Update a subscription to a new plan
|
232
358
|
# @param tr_organization [String] The organization id to use for the request
|
233
359
|
# @param subscription_id [String] id of the subscription you want to update
|
234
360
|
# @param plan_id [String] id of the plan you want to subscribe to
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -20,7 +20,7 @@ module TrieveRubyClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Create Topic
|
23
|
-
# Create
|
23
|
+
# Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
24
24
|
# @param tr_dataset [String] The dataset id to use for the request
|
25
25
|
# @param create_topic_req_payload [CreateTopicReqPayload] JSON request payload to create chat topic
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module TrieveRubyClient
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Create Topic
|
34
|
-
# Create
|
34
|
+
# Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
35
35
|
# @param tr_dataset [String] The dataset id to use for the request
|
36
36
|
# @param create_topic_req_payload [CreateTopicReqPayload] JSON request payload to create chat topic
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -95,7 +95,7 @@ module TrieveRubyClient
|
|
95
95
|
end
|
96
96
|
|
97
97
|
# Delete Topic
|
98
|
-
# Delete
|
98
|
+
# Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
99
99
|
# @param tr_dataset [String] The dataset id to use for the request
|
100
100
|
# @param topic_id [String] The id of the topic you want to delete.
|
101
101
|
# @param [Hash] opts the optional parameters
|
@@ -106,7 +106,7 @@ module TrieveRubyClient
|
|
106
106
|
end
|
107
107
|
|
108
108
|
# Delete Topic
|
109
|
-
# Delete
|
109
|
+
# Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
110
110
|
# @param tr_dataset [String] The dataset id to use for the request
|
111
111
|
# @param topic_id [String] The id of the topic you want to delete.
|
112
112
|
# @param [Hash] opts the optional parameters
|
@@ -165,7 +165,7 @@ module TrieveRubyClient
|
|
165
165
|
end
|
166
166
|
|
167
167
|
# Get All Topics for Owner ID
|
168
|
-
# Get
|
168
|
+
# Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
169
169
|
# @param owner_id [String] The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id
|
170
170
|
# @param tr_dataset [String] The dataset id to use for the request
|
171
171
|
# @param [Hash] opts the optional parameters
|
@@ -176,7 +176,7 @@ module TrieveRubyClient
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# Get All Topics for Owner ID
|
179
|
-
# Get
|
179
|
+
# Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
180
180
|
# @param owner_id [String] The owner_id to get topics of; A common approach is to use a browser fingerprint or your user's id
|
181
181
|
# @param tr_dataset [String] The dataset id to use for the request
|
182
182
|
# @param [Hash] opts the optional parameters
|
@@ -235,7 +235,7 @@ module TrieveRubyClient
|
|
235
235
|
end
|
236
236
|
|
237
237
|
# Update Topic
|
238
|
-
# Update
|
238
|
+
# Update an existing chat topic. Currently, only the name of the topic can be updated. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
239
239
|
# @param tr_dataset [String] The dataset id to use for the request
|
240
240
|
# @param update_topic_req_payload [UpdateTopicReqPayload] JSON request payload to update a chat topic
|
241
241
|
# @param [Hash] opts the optional parameters
|
@@ -246,7 +246,7 @@ module TrieveRubyClient
|
|
246
246
|
end
|
247
247
|
|
248
248
|
# Update Topic
|
249
|
-
# Update
|
249
|
+
# Update an existing chat topic. Currently, only the name of the topic can be updated. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
250
250
|
# @param tr_dataset [String] The dataset id to use for the request
|
251
251
|
# @param update_topic_req_payload [UpdateTopicReqPayload] JSON request payload to update a chat topic
|
252
252
|
# @param [Hash] opts the optional parameters
|
@@ -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
|
# Delete User Api Key
|
23
|
-
# Delete
|
23
|
+
# Delete an api key for the auth'ed user.
|
24
24
|
# @param api_key_id [String] The id of the api key to delete
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
@@ -30,7 +30,7 @@ module TrieveRubyClient
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Delete User Api Key
|
33
|
-
# Delete
|
33
|
+
# Delete an api key for the auth'ed user.
|
34
34
|
# @param api_key_id [String] The id of the api key to delete
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -83,7 +83,7 @@ module TrieveRubyClient
|
|
83
83
|
end
|
84
84
|
|
85
85
|
# Set User Api Key
|
86
|
-
#
|
86
|
+
# Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
|
87
87
|
# @param set_user_api_key_request [SetUserApiKeyRequest] JSON request payload to create a new user api key
|
88
88
|
# @param [Hash] opts the optional parameters
|
89
89
|
# @return [SetUserApiKeyResponse]
|
@@ -93,7 +93,7 @@ module TrieveRubyClient
|
|
93
93
|
end
|
94
94
|
|
95
95
|
# Set User Api Key
|
96
|
-
#
|
96
|
+
# Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
|
97
97
|
# @param set_user_api_key_request [SetUserApiKeyRequest] JSON request payload to create a new user api key
|
98
98
|
# @param [Hash] opts the optional parameters
|
99
99
|
# @return [Array<(SetUserApiKeyResponse, Integer, Hash)>] SetUserApiKeyResponse data, response status code and response headers
|
@@ -151,7 +151,7 @@ module TrieveRubyClient
|
|
151
151
|
end
|
152
152
|
|
153
153
|
# Update User
|
154
|
-
# Update
|
154
|
+
# Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.
|
155
155
|
# @param update_user_org_role_data [UpdateUserOrgRoleData] JSON request payload to update user information for the auth'ed user
|
156
156
|
# @param [Hash] opts the optional parameters
|
157
157
|
# @return [nil]
|
@@ -161,7 +161,7 @@ module TrieveRubyClient
|
|
161
161
|
end
|
162
162
|
|
163
163
|
# Update User
|
164
|
-
# Update
|
164
|
+
# Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.
|
165
165
|
# @param update_user_org_role_data [UpdateUserOrgRoleData] JSON request payload to update user information for the auth'ed user
|
166
166
|
# @param [Hash] opts the optional parameters
|
167
167
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -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
|
@@ -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
|
@@ -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
|
@@ -241,6 +241,13 @@ module TrieveRubyClient
|
|
241
241
|
key: 'Authorization',
|
242
242
|
value: api_key_with_prefix('ApiKey')
|
243
243
|
},
|
244
|
+
'X-API-KEY' =>
|
245
|
+
{
|
246
|
+
type: 'api_key',
|
247
|
+
in: 'header',
|
248
|
+
key: 'X-API-KEY',
|
249
|
+
value: api_key_with_prefix('X-API-KEY')
|
250
|
+
},
|
244
251
|
}
|
245
252
|
end
|
246
253
|
|
@@ -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
|
@@ -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
|
@@ -0,0 +1,40 @@
|
|
1
|
+
=begin
|
2
|
+
#Trieve API
|
3
|
+
|
4
|
+
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
|
+
Contact: developers@trieve.ai
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module TrieveRubyClient
|
17
|
+
class APIVersion
|
18
|
+
V1 = "V1".freeze
|
19
|
+
V2 = "V2".freeze
|
20
|
+
|
21
|
+
def self.all_vars
|
22
|
+
@all_vars ||= [V1, V2].freeze
|
23
|
+
end
|
24
|
+
|
25
|
+
# Builds the enum from string
|
26
|
+
# @param [String] The enum value in the form of the string
|
27
|
+
# @return [String] The enum value
|
28
|
+
def self.build_from_hash(value)
|
29
|
+
new.build_from_hash(value)
|
30
|
+
end
|
31
|
+
|
32
|
+
# Builds the enum from string
|
33
|
+
# @param [String] The enum value in the form of the string
|
34
|
+
# @return [String] The enum value
|
35
|
+
def build_from_hash(value)
|
36
|
+
return value if APIVersion.all_vars.include?(value)
|
37
|
+
raise "Invalid ENUM value #{value} for class #APIVersion"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 0.
|
6
|
+
The version of the OpenAPI document: 0.11.0
|
7
7
|
Contact: developers@trieve.ai
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
Generator version: 7.4.0
|
@@ -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
|
@@ -41,6 +41,8 @@ module TrieveRubyClient
|
|
41
41
|
# Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response's highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once.
|
42
42
|
attr_accessor :highlight_window
|
43
43
|
|
44
|
+
attr_accessor :location_bias
|
45
|
+
|
44
46
|
# Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
|
45
47
|
attr_accessor :page_size
|
46
48
|
|
@@ -50,10 +52,9 @@ module TrieveRubyClient
|
|
50
52
|
# Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. We recommend setting this to 1.0 for a gentle reranking of the results, >3.0 for a strong reranking of the results.
|
51
53
|
attr_accessor :recency_bias
|
52
54
|
|
53
|
-
# Set score_threshold to a float to filter out chunks with a score below the threshold.
|
55
|
+
# Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0.
|
54
56
|
attr_accessor :score_threshold
|
55
57
|
|
56
|
-
# Can be either \"semantic\", or \"fulltext\". \"semantic\" will pull in one page_size of the nearest cosine distant vectors. \"fulltext\" will pull in one page_size of full-text results based on SPLADE.
|
57
58
|
attr_accessor :search_type
|
58
59
|
|
59
60
|
# Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false.
|
@@ -62,9 +63,34 @@ module TrieveRubyClient
|
|
62
63
|
# Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights.
|
63
64
|
attr_accessor :tag_weights
|
64
65
|
|
66
|
+
# If true, chunks will be reranked using scores from a cross encoder model. \"hybrid\" search will always use the reranker regardless of this setting.
|
67
|
+
attr_accessor :use_reranker
|
68
|
+
|
65
69
|
# Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.
|
66
70
|
attr_accessor :use_weights
|
67
71
|
|
72
|
+
class EnumAttributeValidator
|
73
|
+
attr_reader :datatype
|
74
|
+
attr_reader :allowable_values
|
75
|
+
|
76
|
+
def initialize(datatype, allowable_values)
|
77
|
+
@allowable_values = allowable_values.map do |value|
|
78
|
+
case datatype.to_s
|
79
|
+
when /Integer/i
|
80
|
+
value.to_i
|
81
|
+
when /Float/i
|
82
|
+
value.to_f
|
83
|
+
else
|
84
|
+
value
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
def valid?(value)
|
90
|
+
!value || allowable_values.include?(value)
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
68
94
|
# Attribute mapping from ruby-style variable name to JSON key.
|
69
95
|
def self.attribute_map
|
70
96
|
{
|
@@ -77,6 +103,7 @@ module TrieveRubyClient
|
|
77
103
|
:'highlight_results' => :'highlight_results',
|
78
104
|
:'highlight_threshold' => :'highlight_threshold',
|
79
105
|
:'highlight_window' => :'highlight_window',
|
106
|
+
:'location_bias' => :'location_bias',
|
80
107
|
:'page_size' => :'page_size',
|
81
108
|
:'query' => :'query',
|
82
109
|
:'recency_bias' => :'recency_bias',
|
@@ -84,6 +111,7 @@ module TrieveRubyClient
|
|
84
111
|
:'search_type' => :'search_type',
|
85
112
|
:'slim_chunks' => :'slim_chunks',
|
86
113
|
:'tag_weights' => :'tag_weights',
|
114
|
+
:'use_reranker' => :'use_reranker',
|
87
115
|
:'use_weights' => :'use_weights'
|
88
116
|
}
|
89
117
|
end
|
@@ -105,13 +133,15 @@ module TrieveRubyClient
|
|
105
133
|
:'highlight_results' => :'Boolean',
|
106
134
|
:'highlight_threshold' => :'Float',
|
107
135
|
:'highlight_window' => :'Integer',
|
136
|
+
:'location_bias' => :'GeoInfoWithBias',
|
108
137
|
:'page_size' => :'Integer',
|
109
138
|
:'query' => :'String',
|
110
139
|
:'recency_bias' => :'Float',
|
111
140
|
:'score_threshold' => :'Float',
|
112
|
-
:'search_type' => :'
|
141
|
+
:'search_type' => :'SearchMethod',
|
113
142
|
:'slim_chunks' => :'Boolean',
|
114
143
|
:'tag_weights' => :'Hash<String, Float>',
|
144
|
+
:'use_reranker' => :'Boolean',
|
115
145
|
:'use_weights' => :'Boolean'
|
116
146
|
}
|
117
147
|
end
|
@@ -128,11 +158,13 @@ module TrieveRubyClient
|
|
128
158
|
:'highlight_results',
|
129
159
|
:'highlight_threshold',
|
130
160
|
:'highlight_window',
|
161
|
+
:'location_bias',
|
131
162
|
:'page_size',
|
132
163
|
:'recency_bias',
|
133
164
|
:'score_threshold',
|
134
165
|
:'slim_chunks',
|
135
166
|
:'tag_weights',
|
167
|
+
:'use_reranker',
|
136
168
|
:'use_weights'
|
137
169
|
])
|
138
170
|
end
|
@@ -190,6 +222,10 @@ module TrieveRubyClient
|
|
190
222
|
self.highlight_window = attributes[:'highlight_window']
|
191
223
|
end
|
192
224
|
|
225
|
+
if attributes.key?(:'location_bias')
|
226
|
+
self.location_bias = attributes[:'location_bias']
|
227
|
+
end
|
228
|
+
|
193
229
|
if attributes.key?(:'page_size')
|
194
230
|
self.page_size = attributes[:'page_size']
|
195
231
|
end
|
@@ -224,6 +260,10 @@ module TrieveRubyClient
|
|
224
260
|
end
|
225
261
|
end
|
226
262
|
|
263
|
+
if attributes.key?(:'use_reranker')
|
264
|
+
self.use_reranker = attributes[:'use_reranker']
|
265
|
+
end
|
266
|
+
|
227
267
|
if attributes.key?(:'use_weights')
|
228
268
|
self.use_weights = attributes[:'use_weights']
|
229
269
|
end
|
@@ -328,6 +368,7 @@ module TrieveRubyClient
|
|
328
368
|
highlight_results == o.highlight_results &&
|
329
369
|
highlight_threshold == o.highlight_threshold &&
|
330
370
|
highlight_window == o.highlight_window &&
|
371
|
+
location_bias == o.location_bias &&
|
331
372
|
page_size == o.page_size &&
|
332
373
|
query == o.query &&
|
333
374
|
recency_bias == o.recency_bias &&
|
@@ -335,6 +376,7 @@ module TrieveRubyClient
|
|
335
376
|
search_type == o.search_type &&
|
336
377
|
slim_chunks == o.slim_chunks &&
|
337
378
|
tag_weights == o.tag_weights &&
|
379
|
+
use_reranker == o.use_reranker &&
|
338
380
|
use_weights == o.use_weights
|
339
381
|
end
|
340
382
|
|
@@ -347,7 +389,7 @@ module TrieveRubyClient
|
|
347
389
|
# Calculates hash code according to all attributes.
|
348
390
|
# @return [Integer] Hash code
|
349
391
|
def hash
|
350
|
-
[content_only, extend_results, filters, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, tag_weights, use_weights].hash
|
392
|
+
[content_only, extend_results, filters, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, location_bias, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, tag_weights, use_reranker, use_weights].hash
|
351
393
|
end
|
352
394
|
|
353
395
|
# Builds the object from hash
|
@@ -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
|