trieve_ruby_client 0.8.2 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GENERATE_COMMAND.txt +2 -0
- data/README.md +153 -41
- data/docs/APIVersion.md +15 -0
- data/docs/AnalyticsApi.md +303 -0
- data/docs/ApiKeyRespBody.md +32 -0
- data/docs/AuthApi.md +4 -4
- data/docs/AutocompleteData.md +42 -0
- data/docs/AutocompleteReqPayload.md +54 -0
- data/docs/BookmarkGroupResponse.md +49 -0
- data/docs/BookmarkGroupResult.md +1 -1
- data/docs/BoostPhrase.md +20 -0
- data/docs/ChatMessageProxy.md +1 -1
- data/docs/ChunkApi.md +269 -93
- data/docs/ChunkData.md +3 -1
- data/docs/ChunkFilter.md +5 -3
- data/docs/ChunkGroup.md +1 -1
- data/docs/ChunkGroupAndFileId.md +36 -0
- data/docs/ChunkGroupApi.md +136 -114
- data/docs/ChunkMetadata.md +6 -2
- data/docs/ChunkMetadataStringTagSet.md +46 -0
- data/docs/ChunkMetadataTypes.md +51 -0
- data/docs/ChunkMetadataWithScore.md +1 -1
- data/docs/ChunkReqPayload.md +50 -0
- data/docs/ChunkReturnTypes.md +49 -0
- data/docs/ClientDatasetConfiguration.md +0 -2
- data/docs/ClusterAnalytics.md +63 -0
- data/docs/ClusterAnalyticsFilter.md +18 -0
- data/docs/ClusterAnalyticsResponse.md +49 -0
- data/docs/ClusterQueries.md +22 -0
- data/docs/ClusterTopics.md +20 -0
- data/docs/ConditionType.md +49 -0
- data/docs/ContentChunkMetadata.md +32 -0
- data/docs/CountChunkQueryResponseBody.md +18 -0
- data/docs/CountChunksReqPayload.md +26 -0
- data/docs/CountQueries.md +20 -0
- data/docs/CreateChunkGroupReqPayload.md +28 -0
- data/docs/CreateChunkReqPayloadEnum.md +49 -0
- data/docs/CreateDatasetRequest.md +2 -2
- data/docs/CreateMessageData.md +2 -2
- data/docs/CreateMessageReqPayload.md +52 -0
- data/docs/CreateSetupCheckoutSessionResPayload.md +18 -0
- data/docs/CreateTopicReqPayload.md +22 -0
- data/docs/Dataset.md +2 -2
- data/docs/DatasetAnalytics.md +28 -0
- data/docs/DatasetApi.md +184 -32
- data/docs/DatasetDTO.md +0 -2
- data/docs/DateRange.md +24 -0
- data/docs/DeprecatedSearchOverGroupsResponseBody.md +20 -0
- data/docs/DistancePhrase.md +20 -0
- data/docs/EditMessageReqPayload.md +54 -0
- data/docs/Event.md +3 -5
- data/docs/EventTypeRequest.md +15 -0
- data/docs/EventsApi.md +1 -1
- data/docs/FieldCondition.md +2 -0
- data/docs/File.md +1 -1
- data/docs/FileApi.md +10 -10
- data/docs/GenerateChunksRequest.md +13 -1
- data/docs/GeoInfoWithBias.md +20 -0
- data/docs/GetChunksForGroupsResponse.md +22 -0
- data/docs/GetDatasetsPagination.md +20 -0
- data/docs/GetEventsData.md +1 -1
- data/docs/Granularity.md +15 -0
- data/docs/GroupData.md +1 -1
- data/docs/GroupScoreChunk.md +14 -0
- data/docs/GroupsBookmarkQueryResult.md +22 -0
- data/docs/HasIDCondition.md +20 -0
- data/docs/HeadQueries.md +20 -0
- data/docs/HeadQueries1.md +22 -0
- data/docs/HeadQueryResponse.md +18 -0
- data/docs/HealthApi.md +1 -1
- data/docs/InvitationApi.md +1 -1
- data/docs/LatencyGraph.md +22 -0
- data/docs/LatencyGraphResponse.md +18 -0
- data/docs/LowConfidenceQueries.md +24 -0
- data/docs/LowConfidenceRecommendations.md +24 -0
- data/docs/MatchCondition.md +3 -1
- data/docs/MessageApi.md +43 -43
- data/docs/MetricsApi.md +76 -0
- data/docs/NewChunkMetadataTypes.md +51 -0
- data/docs/NoResultQueries.md +22 -0
- data/docs/Organization.md +2 -0
- data/docs/OrganizationApi.md +27 -28
- data/docs/QueryCountResponse.md +18 -0
- data/docs/QueryDetails.md +20 -0
- data/docs/RAGAnalytics.md +63 -0
- data/docs/RAGAnalyticsFilter.md +20 -0
- data/docs/RAGAnalyticsResponse.md +49 -0
- data/docs/RAGQueries.md +26 -0
- data/docs/RAGUsage.md +20 -0
- data/docs/RAGUsageResponse.md +18 -0
- data/docs/RPSGraph.md +22 -0
- data/docs/RPSGraphResponse.md +18 -0
- data/docs/RagQueryEvent.md +30 -0
- data/docs/RagQueryResponse.md +18 -0
- data/docs/RagTypes.md +15 -0
- data/docs/RangeCondition.md +1 -3
- data/docs/RecommendChunksRequest.md +2 -2
- data/docs/RecommendChunksResponseBody.md +18 -0
- data/docs/RecommendGroupChunksRequest.md +2 -2
- data/docs/RecommendGroupsResponse.md +49 -0
- data/docs/RecommendGroupsResponseBody.md +18 -0
- data/docs/RecommendResponseTypes.md +49 -0
- data/docs/RecommendType.md +15 -0
- data/docs/RecommendationAnalytics.md +63 -0
- data/docs/RecommendationAnalyticsFilter.md +20 -0
- data/docs/RecommendationAnalyticsResponse.md +47 -0
- data/docs/RecommendationEvent.md +38 -0
- data/docs/RecommendationQueries.md +26 -0
- data/docs/RecommendationStrategy.md +15 -0
- data/docs/RecommendationType.md +15 -0
- data/docs/RecommendationsEventResponse.md +18 -0
- data/docs/RegenerateMessageReqPayload.md +48 -0
- data/docs/RemoveChunkFromGroupReqPayload.md +18 -0
- data/docs/RoleProxy.md +15 -0
- data/docs/ScoreChunk.md +22 -0
- data/docs/ScoreChunkDTO.md +3 -1
- data/docs/SearchAnalytics.md +77 -0
- data/docs/SearchAnalyticsFilter.md +22 -0
- data/docs/SearchAnalyticsResponse.md +59 -0
- data/docs/SearchChunkData.md +9 -3
- data/docs/SearchChunksReqPayload.md +56 -0
- data/docs/SearchClusterResponse.md +18 -0
- data/docs/SearchClusterTopics.md +28 -0
- data/docs/SearchGroupResponseTypes.md +49 -0
- data/docs/SearchLatencyGraph.md +20 -0
- data/docs/SearchMethod.md +15 -0
- data/docs/SearchMetrics.md +20 -0
- data/docs/SearchOverGroupsData.md +12 -6
- data/docs/SearchOverGroupsResponseBody.md +4 -4
- data/docs/SearchOverGroupsResponseTypes.md +4 -4
- data/docs/SearchOverGroupsResults.md +6 -4
- data/docs/SearchQueries.md +26 -0
- data/docs/SearchQueryEvent.md +34 -0
- data/docs/SearchQueryResponse.md +18 -0
- data/docs/SearchRPSGraph.md +20 -0
- data/docs/SearchResponseBody.md +20 -0
- data/docs/SearchResponseTypes.md +49 -0
- data/docs/SearchResultType.md +49 -0
- data/docs/SearchType.md +15 -0
- data/docs/SearchTypeCount.md +22 -0
- data/docs/SearchWithinGroupData.md +18 -4
- data/docs/SearchWithinGroupResponseBody.md +20 -0
- data/docs/SearchWithinGroupResults.md +1 -1
- data/docs/SetUserApiKeyRequest.md +4 -0
- data/docs/SlimChunkMetadata.md +5 -1
- data/docs/SlimChunkMetadataWithArrayTagSet.md +44 -0
- data/docs/SlimChunkMetadataWithScore.md +1 -1
- data/docs/SortBy.md +15 -0
- data/docs/SortOrder.md +15 -0
- data/docs/StripeApi.md +134 -4
- data/docs/StripeInvoice.md +28 -0
- data/docs/SuggestedQueriesReqPayload.md +18 -0
- data/docs/TopicApi.md +16 -16
- data/docs/UpdateChunkData.md +2 -0
- data/docs/UpdateChunkGroupData.md +3 -1
- data/docs/UpdateChunkReqPayload.md +48 -0
- data/docs/UpdateDatasetRequest.md +2 -0
- data/docs/UpdateGroupByTrackingIDReqPayload.md +26 -0
- data/docs/UpdateTopicReqPayload.md +20 -0
- data/docs/UpdateUserOrgRoleData.md +1 -1
- data/docs/UploadFileReqPayload.md +40 -0
- data/docs/UserApi.md +9 -10
- data/lib/trieve_ruby_client/api/analytics_api.rb +322 -0
- data/lib/trieve_ruby_client/api/auth_api.rb +9 -9
- data/lib/trieve_ruby_client/api/chunk_api.rb +274 -103
- data/lib/trieve_ruby_client/api/chunk_group_api.rb +161 -139
- data/lib/trieve_ruby_client/api/dataset_api.rb +183 -38
- data/lib/trieve_ruby_client/api/events_api.rb +3 -3
- data/lib/trieve_ruby_client/api/file_api.rb +18 -18
- data/lib/trieve_ruby_client/api/health_api.rb +3 -3
- data/lib/trieve_ruby_client/api/invitation_api.rb +3 -3
- data/lib/trieve_ruby_client/api/message_api.rb +52 -52
- data/lib/trieve_ruby_client/api/metrics_api.rb +79 -0
- data/lib/trieve_ruby_client/api/organization_api.rb +33 -33
- data/lib/trieve_ruby_client/api/stripe_api.rb +135 -9
- data/lib/trieve_ruby_client/api/topic_api.rb +27 -27
- data/lib/trieve_ruby_client/api/user_api.rb +12 -12
- data/lib/trieve_ruby_client/api_client.rb +1 -1
- data/lib/trieve_ruby_client/api_error.rb +1 -1
- data/lib/trieve_ruby_client/configuration.rb +8 -1
- data/lib/trieve_ruby_client/models/add_chunk_to_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/api_key_resp_body.rb +325 -0
- data/lib/trieve_ruby_client/models/api_version.rb +40 -0
- data/lib/trieve_ruby_client/models/auth_query.rb +1 -1
- data/lib/trieve_ruby_client/models/autocomplete_data.rb +378 -0
- data/lib/trieve_ruby_client/models/autocomplete_req_payload.rb +509 -0
- data/lib/trieve_ruby_client/models/batch_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_data.rb +1 -1
- data/lib/trieve_ruby_client/models/bookmark_group_response.rb +105 -0
- data/lib/trieve_ruby_client/models/bookmark_group_result.rb +2 -2
- data/lib/trieve_ruby_client/models/boost_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/chat_message_proxy.rb +24 -2
- data/lib/trieve_ruby_client/models/chunk_data.rb +16 -9
- data/lib/trieve_ruby_client/models/chunk_filter.rb +16 -5
- data/lib/trieve_ruby_client/models/chunk_group.rb +5 -3
- data/lib/trieve_ruby_client/models/chunk_group_and_file.rb +1 -1
- data/lib/trieve_ruby_client/models/chunk_group_and_file_id.rb +343 -0
- data/lib/trieve_ruby_client/models/chunk_metadata.rb +35 -5
- data/lib/trieve_ruby_client/models/chunk_metadata_string_tag_set.rb +393 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/chunk_req_payload.rb +397 -0
- data/lib/trieve_ruby_client/models/chunk_return_types.rb +105 -0
- data/lib/trieve_ruby_client/models/client_dataset_configuration.rb +2 -18
- data/lib/trieve_ruby_client/models/cluster_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_filter.rb +215 -0
- data/lib/trieve_ruby_client/models/cluster_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/cluster_queries.rb +296 -0
- data/lib/trieve_ruby_client/models/cluster_topics.rb +265 -0
- data/lib/trieve_ruby_client/models/condition_type.rb +105 -0
- data/lib/trieve_ruby_client/models/content_chunk_metadata.rb +305 -0
- data/lib/trieve_ruby_client/models/count_chunk_query_response_body.rb +240 -0
- data/lib/trieve_ruby_client/models/count_chunks_req_payload.rb +307 -0
- data/lib/trieve_ruby_client/models/count_queries.rb +265 -0
- data/lib/trieve_ruby_client/models/create_chunk_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_chunk_group_req_payload.rb +273 -0
- data/lib/trieve_ruby_client/models/create_chunk_req_payload_enum.rb +105 -0
- data/lib/trieve_ruby_client/models/create_dataset_request.rb +3 -3
- data/lib/trieve_ruby_client/models/create_message_data.rb +13 -13
- data/lib/trieve_ruby_client/models/create_message_req_payload.rb +469 -0
- data/lib/trieve_ruby_client/models/create_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_setup_checkout_session_res_payload.rb +221 -0
- data/lib/trieve_ruby_client/models/create_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/create_topic_req_payload.rb +244 -0
- data/lib/trieve_ruby_client/models/dataset.rb +18 -14
- data/lib/trieve_ruby_client/models/dataset_analytics.rb +301 -0
- data/lib/trieve_ruby_client/models/dataset_and_usage.rb +1 -1
- data/lib/trieve_ruby_client/models/dataset_dto.rb +2 -14
- data/lib/trieve_ruby_client/models/dataset_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/date_range.rb +245 -0
- data/lib/trieve_ruby_client/models/delete_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/delete_user_api_key_request.rb +1 -1
- data/lib/trieve_ruby_client/models/deprecated_search_over_groups_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/distance_phrase.rb +240 -0
- data/lib/trieve_ruby_client/models/edit_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/edit_message_req_payload.rb +486 -0
- data/lib/trieve_ruby_client/models/error_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/event.rb +12 -24
- data/lib/trieve_ruby_client/models/event_return.rb +1 -1
- data/lib/trieve_ruby_client/models/event_type_request.rb +49 -0
- data/lib/trieve_ruby_client/models/field_condition.rb +12 -2
- data/lib/trieve_ruby_client/models/file.rb +5 -3
- data/lib/trieve_ruby_client/models/file_dto.rb +1 -1
- data/lib/trieve_ruby_client/models/generate_chunks_request.rb +89 -6
- data/lib/trieve_ruby_client/models/geo_info.rb +1 -1
- data/lib/trieve_ruby_client/models/geo_info_with_bias.rb +237 -0
- data/lib/trieve_ruby_client/models/geo_types.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_chunks_for_groups_response.rb +274 -0
- data/lib/trieve_ruby_client/models/get_datasets_pagination.rb +225 -0
- data/lib/trieve_ruby_client/models/get_events_data.rb +2 -2
- data/lib/trieve_ruby_client/models/get_groups_for_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/get_tracking_chunks_data.rb +1 -1
- data/lib/trieve_ruby_client/models/granularity.rb +42 -0
- data/lib/trieve_ruby_client/models/group_data.rb +2 -2
- data/lib/trieve_ruby_client/models/group_score_chunk.rb +92 -2
- data/lib/trieve_ruby_client/models/groups_bookmark_query_result.rb +274 -0
- data/lib/trieve_ruby_client/models/has_id_condition.rb +229 -0
- data/lib/trieve_ruby_client/models/head_queries.rb +237 -0
- data/lib/trieve_ruby_client/models/head_queries1.rb +290 -0
- data/lib/trieve_ruby_client/models/head_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/invitation_data.rb +1 -1
- data/lib/trieve_ruby_client/models/latency_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/latency_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/location_bounding_box.rb +1 -1
- data/lib/trieve_ruby_client/models/location_polygon.rb +1 -1
- data/lib/trieve_ruby_client/models/location_radius.rb +1 -1
- data/lib/trieve_ruby_client/models/low_confidence_queries.rb +300 -0
- data/lib/trieve_ruby_client/models/low_confidence_recommendations.rb +300 -0
- data/lib/trieve_ruby_client/models/match_condition.rb +2 -1
- data/lib/trieve_ruby_client/models/message.rb +1 -1
- data/lib/trieve_ruby_client/models/new_chunk_metadata_types.rb +106 -0
- data/lib/trieve_ruby_client/models/no_result_queries.rb +290 -0
- data/lib/trieve_ruby_client/models/organization.rb +18 -2
- data/lib/trieve_ruby_client/models/organization_usage_count.rb +1 -1
- data/lib/trieve_ruby_client/models/query_count_response.rb +223 -0
- data/lib/trieve_ruby_client/models/query_details.rb +271 -0
- data/lib/trieve_ruby_client/models/rag_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/rag_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/rag_analytics_response.rb +105 -0
- data/lib/trieve_ruby_client/models/rag_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/rag_query_event.rb +319 -0
- data/lib/trieve_ruby_client/models/rag_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/rag_types.rb +40 -0
- data/lib/trieve_ruby_client/models/rag_usage.rb +265 -0
- data/lib/trieve_ruby_client/models/rag_usage_response.rb +240 -0
- data/lib/trieve_ruby_client/models/range.rb +1 -1
- data/lib/trieve_ruby_client/models/range_condition.rb +2 -3
- data/lib/trieve_ruby_client/models/recommend_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_chunks_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb +25 -5
- data/lib/trieve_ruby_client/models/recommend_groups_response.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_groups_response_body.rb +223 -0
- data/lib/trieve_ruby_client/models/recommend_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/recommend_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics.rb +43 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_filter.rb +247 -0
- data/lib/trieve_ruby_client/models/recommendation_analytics_response.rb +104 -0
- data/lib/trieve_ruby_client/models/recommendation_event.rb +391 -0
- data/lib/trieve_ruby_client/models/recommendation_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/recommendation_strategy.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendation_type.rb +40 -0
- data/lib/trieve_ruby_client/models/recommendations_event_response.rb +223 -0
- data/lib/trieve_ruby_client/models/regenerate_message_data.rb +1 -1
- data/lib/trieve_ruby_client/models/regenerate_message_req_payload.rb +441 -0
- data/lib/trieve_ruby_client/models/remove_chunk_from_group_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/return_queued_chunk.rb +1 -1
- data/lib/trieve_ruby_client/models/role_proxy.rb +41 -0
- data/lib/trieve_ruby_client/models/rps_graph.rb +275 -0
- data/lib/trieve_ruby_client/models/rps_graph_response.rb +223 -0
- data/lib/trieve_ruby_client/models/score_chunk.rb +249 -0
- data/lib/trieve_ruby_client/models/score_chunk_dto.rb +15 -3
- data/lib/trieve_ruby_client/models/search_analytics.rb +50 -0
- data/lib/trieve_ruby_client/models/search_analytics_filter.rb +257 -0
- data/lib/trieve_ruby_client/models/search_analytics_response.rb +110 -0
- data/lib/trieve_ruby_client/models/search_chunk_data.rb +40 -5
- data/lib/trieve_ruby_client/models/search_chunk_query_response_body.rb +1 -1
- data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb +535 -0
- data/lib/trieve_ruby_client/models/search_cluster_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_cluster_topics.rb +301 -0
- data/lib/trieve_ruby_client/models/search_group_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_latency_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_method.rb +42 -0
- data/lib/trieve_ruby_client/models/search_metrics.rb +265 -0
- data/lib/trieve_ruby_client/models/search_over_groups_data.rb +117 -18
- data/lib/trieve_ruby_client/models/search_over_groups_response_body.rb +23 -23
- data/lib/trieve_ruby_client/models/search_over_groups_response_types.rb +3 -3
- data/lib/trieve_ruby_client/models/search_over_groups_results.rb +33 -23
- data/lib/trieve_ruby_client/models/search_queries.rb +310 -0
- data/lib/trieve_ruby_client/models/search_query_event.rb +351 -0
- data/lib/trieve_ruby_client/models/search_query_response.rb +223 -0
- data/lib/trieve_ruby_client/models/search_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_response_types.rb +105 -0
- data/lib/trieve_ruby_client/models/search_result_type.rb +105 -0
- data/lib/trieve_ruby_client/models/search_rps_graph.rb +237 -0
- data/lib/trieve_ruby_client/models/search_type.rb +42 -0
- data/lib/trieve_ruby_client/models/search_type_count.rb +253 -0
- data/lib/trieve_ruby_client/models/search_within_group_data.rb +151 -7
- data/lib/trieve_ruby_client/models/search_within_group_response_body.rb +239 -0
- data/lib/trieve_ruby_client/models/search_within_group_results.rb +2 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_request.rb +28 -2
- data/lib/trieve_ruby_client/models/set_user_api_key_response.rb +1 -1
- data/lib/trieve_ruby_client/models/single_queued_chunk_response.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_chunk_metadata.rb +31 -3
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_array_tag_set.rb +385 -0
- data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb +8 -2
- data/lib/trieve_ruby_client/models/slim_group.rb +1 -1
- data/lib/trieve_ruby_client/models/slim_user.rb +1 -1
- data/lib/trieve_ruby_client/models/sort_by.rb +41 -0
- data/lib/trieve_ruby_client/models/sort_order.rb +40 -0
- data/lib/trieve_ruby_client/models/stripe_invoice.rb +301 -0
- data/lib/trieve_ruby_client/models/stripe_plan.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_req_payload.rb +222 -0
- data/lib/trieve_ruby_client/models/suggested_queries_request.rb +1 -1
- data/lib/trieve_ruby_client/models/suggested_queries_response.rb +1 -1
- data/lib/trieve_ruby_client/models/topic.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_chunk_data.rb +15 -2
- data/lib/trieve_ruby_client/models/update_chunk_group_data.rb +17 -6
- data/lib/trieve_ruby_client/models/update_chunk_req_payload.rb +386 -0
- data/lib/trieve_ruby_client/models/update_dataset_request.rb +13 -2
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_group_by_tracking_id_req_payload.rb +268 -0
- data/lib/trieve_ruby_client/models/update_organization_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_data.rb +1 -1
- data/lib/trieve_ruby_client/models/update_topic_req_payload.rb +239 -0
- data/lib/trieve_ruby_client/models/update_user_org_role_data.rb +2 -2
- data/lib/trieve_ruby_client/models/upload_file_data.rb +1 -1
- data/lib/trieve_ruby_client/models/upload_file_req_payload.rb +368 -0
- data/lib/trieve_ruby_client/models/upload_file_result.rb +1 -1
- data/lib/trieve_ruby_client/models/user_organization.rb +1 -1
- data/lib/trieve_ruby_client/version.rb +2 -2
- data/lib/trieve_ruby_client.rb +110 -24
- data/openapi-generator.yaml +2 -2
- data/openapi.json +4491 -1230
- data/spec/api/analytics_api_spec.rb +87 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/models/api_key_resp_body_spec.rb +78 -0
- data/spec/models/api_version_spec.rb +30 -0
- data/spec/models/autocomplete_data_spec.rb +108 -0
- data/spec/models/autocomplete_req_payload_spec.rb +132 -0
- data/spec/models/bookmark_group_response_spec.rb +32 -0
- data/spec/models/boost_phrase_spec.rb +42 -0
- data/spec/models/chunk_group_and_file_id_spec.rb +90 -0
- data/spec/models/chunk_metadata_string_tag_set_spec.rb +120 -0
- data/spec/models/chunk_metadata_types_spec.rb +32 -0
- data/spec/models/chunk_req_payload_spec.rb +132 -0
- data/spec/models/chunk_return_types_spec.rb +32 -0
- data/spec/models/cluster_analytics_filter_spec.rb +36 -0
- data/spec/models/cluster_analytics_response_spec.rb +32 -0
- data/spec/models/cluster_analytics_spec.rb +38 -0
- data/spec/models/cluster_queries_spec.rb +52 -0
- data/spec/models/cluster_topics_spec.rb +46 -0
- data/spec/models/condition_type_spec.rb +32 -0
- data/spec/models/content_chunk_metadata_spec.rb +72 -0
- data/spec/models/count_chunk_query_response_body_spec.rb +36 -0
- data/spec/models/count_chunks_req_payload_spec.rb +60 -0
- data/spec/models/count_queries_spec.rb +46 -0
- data/spec/models/create_chunk_group_req_payload_spec.rb +66 -0
- data/spec/models/create_chunk_req_payload_enum_spec.rb +32 -0
- data/spec/models/create_message_req_payload_spec.rb +108 -0
- data/spec/models/create_setup_checkout_session_res_payload_spec.rb +36 -0
- data/spec/models/create_topic_req_payload_spec.rb +48 -0
- data/spec/models/dataset_analytics_spec.rb +66 -0
- data/spec/models/date_range_spec.rb +54 -0
- data/spec/models/deprecated_search_over_groups_response_body_spec.rb +42 -0
- data/spec/models/distance_phrase_spec.rb +42 -0
- data/spec/models/edit_message_req_payload_spec.rb +114 -0
- data/spec/models/event_type_request_spec.rb +30 -0
- data/spec/models/geo_info_with_bias_spec.rb +42 -0
- data/spec/models/get_chunks_for_groups_response_spec.rb +48 -0
- data/spec/models/get_datasets_pagination_spec.rb +42 -0
- data/spec/models/granularity_spec.rb +30 -0
- data/spec/models/groups_bookmark_query_result_spec.rb +48 -0
- data/spec/models/has_id_condition_spec.rb +42 -0
- data/spec/models/head_queries1_spec.rb +52 -0
- data/spec/models/head_queries_spec.rb +42 -0
- data/spec/models/head_query_response_spec.rb +36 -0
- data/spec/models/latency_graph_response_spec.rb +36 -0
- data/spec/models/latency_graph_spec.rb +52 -0
- data/spec/models/low_confidence_queries_spec.rb +58 -0
- data/spec/models/low_confidence_recommendations_spec.rb +58 -0
- data/spec/models/new_chunk_metadata_types_spec.rb +32 -0
- data/spec/models/no_result_queries_spec.rb +52 -0
- data/spec/models/query_count_response_spec.rb +36 -0
- data/spec/models/query_details_spec.rb +46 -0
- data/spec/models/rag_analytics_filter_spec.rb +42 -0
- data/spec/models/rag_analytics_response_spec.rb +32 -0
- data/spec/models/rag_analytics_spec.rb +38 -0
- data/spec/models/rag_queries_spec.rb +64 -0
- data/spec/models/rag_query_event_spec.rb +72 -0
- data/spec/models/rag_query_response_spec.rb +36 -0
- data/spec/models/rag_types_spec.rb +30 -0
- data/spec/models/rag_usage_response_spec.rb +36 -0
- data/spec/models/rag_usage_spec.rb +46 -0
- data/spec/models/recommend_chunks_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_body_spec.rb +36 -0
- data/spec/models/recommend_groups_response_spec.rb +32 -0
- data/spec/models/recommend_response_types_spec.rb +32 -0
- data/spec/models/recommend_type_spec.rb +30 -0
- data/spec/models/recommendation_analytics_filter_spec.rb +42 -0
- data/spec/models/recommendation_analytics_response_spec.rb +32 -0
- data/spec/models/recommendation_analytics_spec.rb +38 -0
- data/spec/models/recommendation_event_spec.rb +96 -0
- data/spec/models/recommendation_queries_spec.rb +64 -0
- data/spec/models/recommendation_strategy_spec.rb +30 -0
- data/spec/models/recommendation_type_spec.rb +30 -0
- data/spec/models/recommendations_event_response_spec.rb +36 -0
- data/spec/models/regenerate_message_req_payload_spec.rb +102 -0
- data/spec/models/remove_chunk_from_group_req_payload_spec.rb +36 -0
- data/spec/models/role_proxy_spec.rb +30 -0
- data/spec/models/rps_graph_response_spec.rb +36 -0
- data/spec/models/rps_graph_spec.rb +52 -0
- data/spec/models/score_chunk_spec.rb +48 -0
- data/spec/models/search_analytics_filter_spec.rb +48 -0
- data/spec/models/search_analytics_response_spec.rb +32 -0
- data/spec/models/search_analytics_spec.rb +38 -0
- data/spec/models/search_chunks_req_payload_spec.rb +144 -0
- data/spec/models/search_cluster_response_spec.rb +36 -0
- data/spec/models/search_cluster_topics_spec.rb +66 -0
- data/spec/models/search_group_response_types_spec.rb +32 -0
- data/spec/models/search_latency_graph_spec.rb +42 -0
- data/spec/models/search_method_spec.rb +30 -0
- data/spec/models/search_metrics_spec.rb +46 -0
- data/spec/models/search_queries_spec.rb +64 -0
- data/spec/models/search_query_event_spec.rb +84 -0
- data/spec/models/search_query_response_spec.rb +36 -0
- data/spec/models/search_response_body_spec.rb +42 -0
- data/spec/models/search_response_types_spec.rb +32 -0
- data/spec/models/search_result_type_spec.rb +32 -0
- data/spec/models/search_rps_graph_spec.rb +42 -0
- data/spec/models/search_type_count_spec.rb +48 -0
- data/spec/models/search_type_spec.rb +30 -0
- data/spec/models/search_within_group_response_body_spec.rb +42 -0
- data/spec/models/slim_chunk_metadata_with_array_tag_set_spec.rb +114 -0
- data/spec/models/sort_by_spec.rb +30 -0
- data/spec/models/sort_order_spec.rb +30 -0
- data/spec/models/stripe_invoice_spec.rb +66 -0
- data/spec/models/suggested_queries_req_payload_spec.rb +36 -0
- data/spec/models/update_chunk_req_payload_spec.rb +120 -0
- data/spec/models/update_group_by_tracking_id_req_payload_spec.rb +60 -0
- data/spec/models/update_topic_req_payload_spec.rb +42 -0
- data/spec/models/upload_file_req_payload_spec.rb +102 -0
- data/spec/spec_helper.rb +1 -1
- data/trieve_ruby_client.gemspec +1 -1
- metadata +534 -111
- data/trieve_ruby_client-0.5.0.gem +0 -0
- data/trieve_ruby_client-0.5.7.gem +0 -0
- data/trieve_ruby_client-0.6.0.gem +0 -0
- data/trieve_ruby_client-0.6.2.gem +0 -0
- data/trieve_ruby_client-0.6.7.gem +0 -0
- data/trieve_ruby_client-0.6.9.gem +0 -0
- data/trieve_ruby_client-0.7.2.gem +0 -0
- data/trieve_ruby_client-0.7.6.gem +0 -0
- data/trieve_ruby_client-0.8.0.gem +0 -0
data/docs/CreateMessageData.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
|
8
7
|
| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
|
8
|
+
| **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>` tags to the chunk_html of the chunks to highlight matching sub-sentences. | [optional] |
|
9
9
|
| **new_message_content** | **String** | The content of the user message to attach to the topic and then generate an assistant message in response to. | |
|
10
10
|
| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
|
11
11
|
| **topic_id** | **String** | The ID of the topic to attach the message to. | |
|
@@ -16,8 +16,8 @@
|
|
16
16
|
require 'trieve_ruby_client'
|
17
17
|
|
18
18
|
instance = TrieveRubyClient::CreateMessageData.new(
|
19
|
-
highlight_citations: null,
|
20
19
|
highlight_delimiters: null,
|
20
|
+
highlight_results: null,
|
21
21
|
new_message_content: null,
|
22
22
|
stream_response: null,
|
23
23
|
topic_id: null
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# TrieveRubyClient::CreateMessageReqPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **completion_first** | **Boolean** | Completion first decides whether the stream should contain the stream of the completion response or the chunks first. Default is false. Keep in mind that || is used to separate the chunks from the completion response. If || is in the completion then you may want to split on ||{ instead. | [optional] |
|
8
|
+
| **concat_user_messages_query** | **Boolean** | If concat user messages query is set to true, all of the user messages in the topic will be concatenated together and used as the search query. If not specified, this defaults to false. Default is false. | [optional] |
|
9
|
+
| **filters** | [**ChunkFilter**](ChunkFilter.md) | | [optional] |
|
10
|
+
| **frequency_penalty** | **Float** | Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. Default is 0.7. | [optional] |
|
11
|
+
| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
|
12
|
+
| **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>` tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response. | [optional] |
|
13
|
+
| **max_tokens** | **Integer** | The maximum number of tokens to generate in the chat completion. Default is None. | [optional] |
|
14
|
+
| **new_message_content** | **String** | The content of the user message to attach to the topic and then generate an assistant message in response to. | |
|
15
|
+
| **page_size** | **Integer** | Page size is the number of chunks to fetch during RAG. If 0, then no search will be performed. If specified, this will override the N retrievals to include in the dataset configuration. Default is None. | [optional] |
|
16
|
+
| **presence_penalty** | **Float** | Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Default is 0.7. | [optional] |
|
17
|
+
| **score_threshold** | **Float** | 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. | [optional] |
|
18
|
+
| **search_query** | **String** | Query is the search query. This can be any string. The search_query will be used to create a dense embedding vector and/or sparse vector which will be used to find the result set. If not specified, will default to the last user message or HyDE if HyDE is enabled in the dataset configuration. Default is None. | [optional] |
|
19
|
+
| **search_type** | [**SearchMethod**](SearchMethod.md) | | [optional] |
|
20
|
+
| **stop_tokens** | **Array<String>** | Stop tokens are up to 4 sequences where the API will stop generating further tokens. Default is None. | [optional] |
|
21
|
+
| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
|
22
|
+
| **system_prompt** | **String** | Optionally, override the system prompt in dataset server settings. | [optional] |
|
23
|
+
| **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.5. | [optional] |
|
24
|
+
| **topic_id** | **String** | The ID of the topic to attach the message to. | |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'trieve_ruby_client'
|
30
|
+
|
31
|
+
instance = TrieveRubyClient::CreateMessageReqPayload.new(
|
32
|
+
completion_first: null,
|
33
|
+
concat_user_messages_query: null,
|
34
|
+
filters: null,
|
35
|
+
frequency_penalty: null,
|
36
|
+
highlight_delimiters: null,
|
37
|
+
highlight_results: null,
|
38
|
+
max_tokens: null,
|
39
|
+
new_message_content: null,
|
40
|
+
page_size: null,
|
41
|
+
presence_penalty: null,
|
42
|
+
score_threshold: null,
|
43
|
+
search_query: null,
|
44
|
+
search_type: null,
|
45
|
+
stop_tokens: null,
|
46
|
+
stream_response: null,
|
47
|
+
system_prompt: null,
|
48
|
+
temperature: null,
|
49
|
+
topic_id: null
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TrieveRubyClient::CreateSetupCheckoutSessionResPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **url** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'trieve_ruby_client'
|
13
|
+
|
14
|
+
instance = TrieveRubyClient::CreateSetupCheckoutSessionResPayload.new(
|
15
|
+
url: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TrieveRubyClient::CreateTopicReqPayload
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_user_message** | **String** | The first message which will belong to the topic. The topic name is generated based on this message similar to how it works in the OpenAI chat UX if a name is not explicitly provided on the name request body key. | [optional] |
|
8
|
+
| **name** | **String** | The name of the topic. If this is not provided, the topic name is generated from the first_user_message. | [optional] |
|
9
|
+
| **owner_id** | **String** | The owner_id of the topic. This is typically a browser fingerprint or your user's id. It is used to group topics together for a user. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'trieve_ruby_client'
|
15
|
+
|
16
|
+
instance = TrieveRubyClient::CreateTopicReqPayload.new(
|
17
|
+
first_user_message: null,
|
18
|
+
name: null,
|
19
|
+
owner_id: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Dataset.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_configuration** | **Object** | | |
|
8
7
|
| **created_at** | **Time** | | |
|
8
|
+
| **deleted** | **Integer** | | |
|
9
9
|
| **id** | **String** | | |
|
10
10
|
| **name** | **String** | | |
|
11
11
|
| **organization_id** | **String** | | |
|
@@ -19,8 +19,8 @@
|
|
19
19
|
require 'trieve_ruby_client'
|
20
20
|
|
21
21
|
instance = TrieveRubyClient::Dataset.new(
|
22
|
-
client_configuration: null,
|
23
22
|
created_at: null,
|
23
|
+
deleted: null,
|
24
24
|
id: null,
|
25
25
|
name: null,
|
26
26
|
organization_id: null,
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# TrieveRubyClient::DatasetAnalytics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **avg_latency** | **Float** | | |
|
8
|
+
| **p50** | **Float** | | |
|
9
|
+
| **p95** | **Float** | | |
|
10
|
+
| **p99** | **Float** | | |
|
11
|
+
| **search_rps** | **Float** | | |
|
12
|
+
| **total_queries** | **Integer** | | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'trieve_ruby_client'
|
18
|
+
|
19
|
+
instance = TrieveRubyClient::DatasetAnalytics.new(
|
20
|
+
avg_latency: null,
|
21
|
+
p50: null,
|
22
|
+
p95: null,
|
23
|
+
p99: null,
|
24
|
+
search_rps: null,
|
25
|
+
total_queries: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/DatasetApi.md
CHANGED
@@ -4,21 +4,95 @@ All URIs are relative to *https://api.trieve.ai*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**clear_dataset**](DatasetApi.md#clear_dataset) | **PUT** /api/dataset/clear/{dataset_id} | Clear Dataset |
|
7
8
|
| [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset |
|
8
9
|
| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset |
|
9
|
-
| [**
|
10
|
+
| [**delete_dataset_by_tracking_id**](DatasetApi.md#delete_dataset_by_tracking_id) | **DELETE** /api/dataset/tracking_id/{tracking_id} | Delete Dataset by Tracking ID |
|
10
11
|
| [**get_dataset**](DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset |
|
11
12
|
| [**get_datasets_from_organization**](DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization |
|
13
|
+
| [**get_usage_by_dataset_id**](DatasetApi.md#get_usage_by_dataset_id) | **GET** /api/dataset/usage/{dataset_id} | Get Usage By Dataset ID |
|
12
14
|
| [**update_dataset**](DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset |
|
13
15
|
|
14
16
|
|
17
|
+
## clear_dataset
|
18
|
+
|
19
|
+
> clear_dataset(tr_dataset, dataset_id)
|
20
|
+
|
21
|
+
Clear Dataset
|
22
|
+
|
23
|
+
Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'trieve_ruby_client'
|
30
|
+
# setup authorization
|
31
|
+
TrieveRubyClient.configure do |config|
|
32
|
+
# Configure API key authorization: ApiKey
|
33
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
34
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = TrieveRubyClient::DatasetApi.new
|
39
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
40
|
+
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to clear.
|
41
|
+
|
42
|
+
begin
|
43
|
+
# Clear Dataset
|
44
|
+
api_instance.clear_dataset(tr_dataset, dataset_id)
|
45
|
+
rescue TrieveRubyClient::ApiError => e
|
46
|
+
puts "Error when calling DatasetApi->clear_dataset: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the clear_dataset_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
53
|
+
|
54
|
+
> <Array(nil, Integer, Hash)> clear_dataset_with_http_info(tr_dataset, dataset_id)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
# Clear Dataset
|
59
|
+
data, status_code, headers = api_instance.clear_dataset_with_http_info(tr_dataset, dataset_id)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => nil
|
63
|
+
rescue TrieveRubyClient::ApiError => e
|
64
|
+
puts "Error when calling DatasetApi->clear_dataset_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
73
|
+
| **dataset_id** | **String** | The id of the dataset you want to clear. | |
|
74
|
+
|
75
|
+
### Return type
|
76
|
+
|
77
|
+
nil (empty response body)
|
78
|
+
|
79
|
+
### Authorization
|
80
|
+
|
81
|
+
[ApiKey](../README.md#ApiKey)
|
82
|
+
|
83
|
+
### HTTP request headers
|
84
|
+
|
85
|
+
- **Content-Type**: Not defined
|
86
|
+
- **Accept**: application/json
|
87
|
+
|
88
|
+
|
15
89
|
## create_dataset
|
16
90
|
|
17
91
|
> <Dataset> create_dataset(tr_organization, create_dataset_request)
|
18
92
|
|
19
93
|
Create dataset
|
20
94
|
|
21
|
-
Create
|
95
|
+
Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
|
22
96
|
|
23
97
|
### Examples
|
24
98
|
|
@@ -91,7 +165,7 @@ end
|
|
91
165
|
|
92
166
|
Delete Dataset
|
93
167
|
|
94
|
-
Delete
|
168
|
+
Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
|
95
169
|
|
96
170
|
### Examples
|
97
171
|
|
@@ -157,13 +231,13 @@ nil (empty response body)
|
|
157
231
|
- **Accept**: application/json
|
158
232
|
|
159
233
|
|
160
|
-
##
|
234
|
+
## delete_dataset_by_tracking_id
|
161
235
|
|
162
|
-
>
|
236
|
+
> delete_dataset_by_tracking_id(tr_dataset, tracking_id)
|
163
237
|
|
164
|
-
|
238
|
+
Delete Dataset by Tracking ID
|
165
239
|
|
166
|
-
|
240
|
+
Delete a dataset by its tracking id. The auth'ed user must be an owner of the organization to delete a dataset.
|
167
241
|
|
168
242
|
### Examples
|
169
243
|
|
@@ -180,31 +254,31 @@ end
|
|
180
254
|
|
181
255
|
api_instance = TrieveRubyClient::DatasetApi.new
|
182
256
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
257
|
+
tracking_id = 'tracking_id_example' # String | The tracking id of the dataset you want to delete.
|
183
258
|
|
184
259
|
begin
|
185
|
-
#
|
186
|
-
|
187
|
-
p result
|
260
|
+
# Delete Dataset by Tracking ID
|
261
|
+
api_instance.delete_dataset_by_tracking_id(tr_dataset, tracking_id)
|
188
262
|
rescue TrieveRubyClient::ApiError => e
|
189
|
-
puts "Error when calling DatasetApi->
|
263
|
+
puts "Error when calling DatasetApi->delete_dataset_by_tracking_id: #{e}"
|
190
264
|
end
|
191
265
|
```
|
192
266
|
|
193
|
-
#### Using the
|
267
|
+
#### Using the delete_dataset_by_tracking_id_with_http_info variant
|
194
268
|
|
195
|
-
This returns an Array which contains the response data, status code and headers.
|
269
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
196
270
|
|
197
|
-
> <Array(
|
271
|
+
> <Array(nil, Integer, Hash)> delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id)
|
198
272
|
|
199
273
|
```ruby
|
200
274
|
begin
|
201
|
-
#
|
202
|
-
data, status_code, headers = api_instance.
|
275
|
+
# Delete Dataset by Tracking ID
|
276
|
+
data, status_code, headers = api_instance.delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id)
|
203
277
|
p status_code # => 2xx
|
204
278
|
p headers # => { ... }
|
205
|
-
p data # =>
|
279
|
+
p data # => nil
|
206
280
|
rescue TrieveRubyClient::ApiError => e
|
207
|
-
puts "Error when calling DatasetApi->
|
281
|
+
puts "Error when calling DatasetApi->delete_dataset_by_tracking_id_with_http_info: #{e}"
|
208
282
|
end
|
209
283
|
```
|
210
284
|
|
@@ -213,10 +287,11 @@ end
|
|
213
287
|
| Name | Type | Description | Notes |
|
214
288
|
| ---- | ---- | ----------- | ----- |
|
215
289
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
290
|
+
| **tracking_id** | **String** | The tracking id of the dataset you want to delete. | |
|
216
291
|
|
217
292
|
### Return type
|
218
293
|
|
219
|
-
|
294
|
+
nil (empty response body)
|
220
295
|
|
221
296
|
### Authorization
|
222
297
|
|
@@ -230,11 +305,11 @@ end
|
|
230
305
|
|
231
306
|
## get_dataset
|
232
307
|
|
233
|
-
> <Dataset> get_dataset(
|
308
|
+
> <Dataset> get_dataset(tr_dataset, dataset_id)
|
234
309
|
|
235
310
|
Get Dataset
|
236
311
|
|
237
|
-
Get
|
312
|
+
Get a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
238
313
|
|
239
314
|
### Examples
|
240
315
|
|
@@ -250,13 +325,12 @@ TrieveRubyClient.configure do |config|
|
|
250
325
|
end
|
251
326
|
|
252
327
|
api_instance = TrieveRubyClient::DatasetApi.new
|
253
|
-
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
|
254
328
|
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
255
329
|
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to retrieve.
|
256
330
|
|
257
331
|
begin
|
258
332
|
# Get Dataset
|
259
|
-
result = api_instance.get_dataset(
|
333
|
+
result = api_instance.get_dataset(tr_dataset, dataset_id)
|
260
334
|
p result
|
261
335
|
rescue TrieveRubyClient::ApiError => e
|
262
336
|
puts "Error when calling DatasetApi->get_dataset: #{e}"
|
@@ -267,12 +341,12 @@ end
|
|
267
341
|
|
268
342
|
This returns an Array which contains the response data, status code and headers.
|
269
343
|
|
270
|
-
> <Array(<Dataset>, Integer, Hash)> get_dataset_with_http_info(
|
344
|
+
> <Array(<Dataset>, Integer, Hash)> get_dataset_with_http_info(tr_dataset, dataset_id)
|
271
345
|
|
272
346
|
```ruby
|
273
347
|
begin
|
274
348
|
# Get Dataset
|
275
|
-
data, status_code, headers = api_instance.get_dataset_with_http_info(
|
349
|
+
data, status_code, headers = api_instance.get_dataset_with_http_info(tr_dataset, dataset_id)
|
276
350
|
p status_code # => 2xx
|
277
351
|
p headers # => { ... }
|
278
352
|
p data # => <Dataset>
|
@@ -285,7 +359,6 @@ end
|
|
285
359
|
|
286
360
|
| Name | Type | Description | Notes |
|
287
361
|
| ---- | ---- | ----------- | ----- |
|
288
|
-
| **tr_organization** | **String** | The organization id to use for the request | |
|
289
362
|
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
290
363
|
| **dataset_id** | **String** | The id of the dataset you want to retrieve. | |
|
291
364
|
|
@@ -305,11 +378,11 @@ end
|
|
305
378
|
|
306
379
|
## get_datasets_from_organization
|
307
380
|
|
308
|
-
> <Array<DatasetAndUsage>> get_datasets_from_organization(tr_organization, organization_id)
|
381
|
+
> <Array<DatasetAndUsage>> get_datasets_from_organization(tr_organization, organization_id, opts)
|
309
382
|
|
310
383
|
Get Datasets from Organization
|
311
384
|
|
312
|
-
Get
|
385
|
+
Get all datasets for an organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
|
313
386
|
|
314
387
|
### Examples
|
315
388
|
|
@@ -327,10 +400,14 @@ end
|
|
327
400
|
api_instance = TrieveRubyClient::DatasetApi.new
|
328
401
|
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
|
329
402
|
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the organization you want to retrieve datasets for
|
403
|
+
opts = {
|
404
|
+
limit: 789, # Integer | The number of records to return
|
405
|
+
offset: 789 # Integer | The number of records to skip
|
406
|
+
}
|
330
407
|
|
331
408
|
begin
|
332
409
|
# Get Datasets from Organization
|
333
|
-
result = api_instance.get_datasets_from_organization(tr_organization, organization_id)
|
410
|
+
result = api_instance.get_datasets_from_organization(tr_organization, organization_id, opts)
|
334
411
|
p result
|
335
412
|
rescue TrieveRubyClient::ApiError => e
|
336
413
|
puts "Error when calling DatasetApi->get_datasets_from_organization: #{e}"
|
@@ -341,12 +418,12 @@ end
|
|
341
418
|
|
342
419
|
This returns an Array which contains the response data, status code and headers.
|
343
420
|
|
344
|
-
> <Array(<Array<DatasetAndUsage>>, Integer, Hash)> get_datasets_from_organization_with_http_info(tr_organization, organization_id)
|
421
|
+
> <Array(<Array<DatasetAndUsage>>, Integer, Hash)> get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
|
345
422
|
|
346
423
|
```ruby
|
347
424
|
begin
|
348
425
|
# Get Datasets from Organization
|
349
|
-
data, status_code, headers = api_instance.get_datasets_from_organization_with_http_info(tr_organization, organization_id)
|
426
|
+
data, status_code, headers = api_instance.get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
|
350
427
|
p status_code # => 2xx
|
351
428
|
p headers # => { ... }
|
352
429
|
p data # => <Array<DatasetAndUsage>>
|
@@ -361,6 +438,8 @@ end
|
|
361
438
|
| ---- | ---- | ----------- | ----- |
|
362
439
|
| **tr_organization** | **String** | The organization id to use for the request | |
|
363
440
|
| **organization_id** | **String** | id of the organization you want to retrieve datasets for | |
|
441
|
+
| **limit** | **Integer** | The number of records to return | [optional] |
|
442
|
+
| **offset** | **Integer** | The number of records to skip | [optional] |
|
364
443
|
|
365
444
|
### Return type
|
366
445
|
|
@@ -376,13 +455,86 @@ end
|
|
376
455
|
- **Accept**: application/json
|
377
456
|
|
378
457
|
|
458
|
+
## get_usage_by_dataset_id
|
459
|
+
|
460
|
+
> <DatasetUsageCount> get_usage_by_dataset_id(tr_dataset, dataset_id)
|
461
|
+
|
462
|
+
Get Usage By Dataset ID
|
463
|
+
|
464
|
+
Get the usage for a dataset by its id.
|
465
|
+
|
466
|
+
### Examples
|
467
|
+
|
468
|
+
```ruby
|
469
|
+
require 'time'
|
470
|
+
require 'trieve_ruby_client'
|
471
|
+
# setup authorization
|
472
|
+
TrieveRubyClient.configure do |config|
|
473
|
+
# Configure API key authorization: ApiKey
|
474
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
475
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
476
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = TrieveRubyClient::DatasetApi.new
|
480
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
481
|
+
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to retrieve usage for.
|
482
|
+
|
483
|
+
begin
|
484
|
+
# Get Usage By Dataset ID
|
485
|
+
result = api_instance.get_usage_by_dataset_id(tr_dataset, dataset_id)
|
486
|
+
p result
|
487
|
+
rescue TrieveRubyClient::ApiError => e
|
488
|
+
puts "Error when calling DatasetApi->get_usage_by_dataset_id: #{e}"
|
489
|
+
end
|
490
|
+
```
|
491
|
+
|
492
|
+
#### Using the get_usage_by_dataset_id_with_http_info variant
|
493
|
+
|
494
|
+
This returns an Array which contains the response data, status code and headers.
|
495
|
+
|
496
|
+
> <Array(<DatasetUsageCount>, Integer, Hash)> get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id)
|
497
|
+
|
498
|
+
```ruby
|
499
|
+
begin
|
500
|
+
# Get Usage By Dataset ID
|
501
|
+
data, status_code, headers = api_instance.get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id)
|
502
|
+
p status_code # => 2xx
|
503
|
+
p headers # => { ... }
|
504
|
+
p data # => <DatasetUsageCount>
|
505
|
+
rescue TrieveRubyClient::ApiError => e
|
506
|
+
puts "Error when calling DatasetApi->get_usage_by_dataset_id_with_http_info: #{e}"
|
507
|
+
end
|
508
|
+
```
|
509
|
+
|
510
|
+
### Parameters
|
511
|
+
|
512
|
+
| Name | Type | Description | Notes |
|
513
|
+
| ---- | ---- | ----------- | ----- |
|
514
|
+
| **tr_dataset** | **String** | The dataset id to use for the request | |
|
515
|
+
| **dataset_id** | **String** | The id of the dataset you want to retrieve usage for. | |
|
516
|
+
|
517
|
+
### Return type
|
518
|
+
|
519
|
+
[**DatasetUsageCount**](DatasetUsageCount.md)
|
520
|
+
|
521
|
+
### Authorization
|
522
|
+
|
523
|
+
[ApiKey](../README.md#ApiKey)
|
524
|
+
|
525
|
+
### HTTP request headers
|
526
|
+
|
527
|
+
- **Content-Type**: Not defined
|
528
|
+
- **Accept**: application/json
|
529
|
+
|
530
|
+
|
379
531
|
## update_dataset
|
380
532
|
|
381
533
|
> <Dataset> update_dataset(tr_organization, update_dataset_request)
|
382
534
|
|
383
535
|
Update Dataset
|
384
536
|
|
385
|
-
Update
|
537
|
+
Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
|
386
538
|
|
387
539
|
### Examples
|
388
540
|
|
data/docs/DatasetDTO.md
CHANGED
@@ -4,7 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **client_configuration** | **Object** | | |
|
8
7
|
| **created_at** | **Time** | | |
|
9
8
|
| **id** | **String** | | |
|
10
9
|
| **name** | **String** | | |
|
@@ -18,7 +17,6 @@
|
|
18
17
|
require 'trieve_ruby_client'
|
19
18
|
|
20
19
|
instance = TrieveRubyClient::DatasetDTO.new(
|
21
|
-
client_configuration: null,
|
22
20
|
created_at: null,
|
23
21
|
id: null,
|
24
22
|
name: null,
|
data/docs/DateRange.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# TrieveRubyClient::DateRange
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **gt** | **String** | | [optional] |
|
8
|
+
| **gte** | **String** | | [optional] |
|
9
|
+
| **lt** | **String** | | [optional] |
|
10
|
+
| **lte** | **String** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'trieve_ruby_client'
|
16
|
+
|
17
|
+
instance = TrieveRubyClient::DateRange.new(
|
18
|
+
gt: null,
|
19
|
+
gte: null,
|
20
|
+
lt: null,
|
21
|
+
lte: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::DeprecatedSearchOverGroupsResponseBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **group_chunks** | [**Array<GroupScoreChunk>**](GroupScoreChunk.md) | | |
|
8
|
+
| **total_chunk_pages** | **Integer** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::DeprecatedSearchOverGroupsResponseBody.new(
|
16
|
+
group_chunks: null,
|
17
|
+
total_chunk_pages: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TrieveRubyClient::DistancePhrase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **distance_factor** | **Float** | Amount to multiplicatevly increase the frequency of the tokens in the phrase by | |
|
8
|
+
| **phrase** | **String** | The phrase to boost in the fulltext document frequency index | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'trieve_ruby_client'
|
14
|
+
|
15
|
+
instance = TrieveRubyClient::DistancePhrase.new(
|
16
|
+
distance_factor: null,
|
17
|
+
phrase: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|