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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6907f99f20fe4dff904e3daf46a25609d15085a9f51cc7c724cda992196ae964
|
|
4
|
+
data.tar.gz: 861b41bc2412fdb50f7312aa74aea47635e95adf29e6eff315f9e7a62146263f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8470523e7ef46b499a3c73fcf86189efaf690fbc80f6b222d403c8039bb0fb6083ce3554445b884d55598c4840b6abe72aaf01c3587229828bc0a5b1555c64d5
|
|
7
|
+
data.tar.gz: 96ef993ec11b32bb7b6d7c8a93fe7fd360a2998d6f56aba33ac821375a7068b9fb5c92613dca77715bdccb833dba277cef5019304c1df8746f83eb092748a708
|
data/GENERATE_COMMAND.txt
CHANGED
data/README.md
CHANGED
|
@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
|
|
|
6
6
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
|
-
- API version: 0.
|
|
10
|
-
- Package version: 0.
|
|
9
|
+
- API version: 0.11.0
|
|
10
|
+
- Package version: 0.11.0
|
|
11
11
|
- Generator version: 7.4.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
For more information, please visit [https://trieve.ai](https://trieve.ai)
|
|
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
|
|
|
25
25
|
Then either install the gem locally:
|
|
26
26
|
|
|
27
27
|
```shell
|
|
28
|
-
gem install ./trieve_ruby_client-0.
|
|
28
|
+
gem install ./trieve_ruby_client-0.11.0.gem
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
(for development, run `gem install --dev ./trieve_ruby_client-0.
|
|
31
|
+
(for development, run `gem install --dev ./trieve_ruby_client-0.11.0.gem` to install the development dependencies)
|
|
32
32
|
|
|
33
33
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
34
34
|
|
|
35
35
|
Finally add this to the Gemfile:
|
|
36
36
|
|
|
37
|
-
gem 'trieve_ruby_client', '~> 0.
|
|
37
|
+
gem 'trieve_ruby_client', '~> 0.11.0'
|
|
38
38
|
|
|
39
39
|
### Install from Git
|
|
40
40
|
|
|
@@ -58,14 +58,24 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
|
58
58
|
# Load the gem
|
|
59
59
|
require 'trieve_ruby_client'
|
|
60
60
|
|
|
61
|
-
|
|
61
|
+
# Setup authorization
|
|
62
|
+
TrieveRubyClient.configure do |config|
|
|
63
|
+
# Configure API key authorization: ApiKey
|
|
64
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
|
65
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
66
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
api_instance = TrieveRubyClient::AnalyticsApi.new
|
|
70
|
+
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
|
|
71
|
+
cluster_analytics = TrieveRubyClient::ClusterQueries.new({cluster_id: 'cluster_id_example', type: 'cluster_queries'}) # ClusterAnalytics | JSON request payload to filter the graph
|
|
62
72
|
|
|
63
73
|
begin
|
|
64
|
-
#
|
|
65
|
-
result = api_instance.
|
|
74
|
+
#Get Cluster Analytics
|
|
75
|
+
result = api_instance.get_cluster_analytics(tr_dataset, cluster_analytics)
|
|
66
76
|
p result
|
|
67
77
|
rescue TrieveRubyClient::ApiError => e
|
|
68
|
-
puts "Exception when calling
|
|
78
|
+
puts "Exception when calling AnalyticsApi->get_cluster_analytics: #{e}"
|
|
69
79
|
end
|
|
70
80
|
|
|
71
81
|
```
|
|
@@ -76,20 +86,26 @@ All URIs are relative to *https://api.trieve.ai*
|
|
|
76
86
|
|
|
77
87
|
Class | Method | HTTP request | Description
|
|
78
88
|
------------ | ------------- | ------------- | -------------
|
|
89
|
+
*TrieveRubyClient::AnalyticsApi* | [**get_cluster_analytics**](docs/AnalyticsApi.md#get_cluster_analytics) | **POST** /api/analytics/search/cluster | Get Cluster Analytics
|
|
90
|
+
*TrieveRubyClient::AnalyticsApi* | [**get_rag_analytics**](docs/AnalyticsApi.md#get_rag_analytics) | **POST** /api/analytics/rag | Get RAG Analytics
|
|
91
|
+
*TrieveRubyClient::AnalyticsApi* | [**get_recommendation_analytics**](docs/AnalyticsApi.md#get_recommendation_analytics) | **POST** /api/analytics/recommendation | Get Recommendation Analytics
|
|
92
|
+
*TrieveRubyClient::AnalyticsApi* | [**get_search_analytics**](docs/AnalyticsApi.md#get_search_analytics) | **POST** /api/analytics/search | Get Search Analytics
|
|
79
93
|
*TrieveRubyClient::AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback
|
|
80
94
|
*TrieveRubyClient::AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | Get Me
|
|
81
95
|
*TrieveRubyClient::AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | Login
|
|
82
96
|
*TrieveRubyClient::AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | Logout
|
|
97
|
+
*TrieveRubyClient::ChunkApi* | [**autocomplete**](docs/ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete
|
|
98
|
+
*TrieveRubyClient::ChunkApi* | [**count_chunks**](docs/ChunkApi.md#count_chunks) | **POST** /api/chunk/count | Count chunks above threshold
|
|
83
99
|
*TrieveRubyClient::ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks
|
|
84
|
-
*TrieveRubyClient::ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
|
|
85
100
|
*TrieveRubyClient::ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk
|
|
86
101
|
*TrieveRubyClient::ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id
|
|
87
102
|
*TrieveRubyClient::ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | RAG on Specified Chunks
|
|
88
103
|
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id
|
|
89
104
|
*TrieveRubyClient::ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id
|
|
90
105
|
*TrieveRubyClient::ChunkApi* | [**get_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids
|
|
91
|
-
*TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By
|
|
106
|
+
*TrieveRubyClient::ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By Tracking Ids
|
|
92
107
|
*TrieveRubyClient::ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks
|
|
108
|
+
*TrieveRubyClient::ChunkApi* | [**get_suggested_queries**](docs/ChunkApi.md#get_suggested_queries) | **POST** /api/chunk/gen_suggestions | Generate suggested queries
|
|
93
109
|
*TrieveRubyClient::ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search
|
|
94
110
|
*TrieveRubyClient::ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | Update Chunk
|
|
95
111
|
*TrieveRubyClient::ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id
|
|
@@ -103,18 +119,20 @@ Class | Method | HTTP request | Description
|
|
|
103
119
|
*TrieveRubyClient::ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID
|
|
104
120
|
*TrieveRubyClient::ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID
|
|
105
121
|
*TrieveRubyClient::ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks
|
|
122
|
+
*TrieveRubyClient::ChunkGroupApi* | [**get_groups_for_dataset**](docs/ChunkGroupApi.md#get_groups_for_dataset) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset
|
|
106
123
|
*TrieveRubyClient::ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups
|
|
107
|
-
*TrieveRubyClient::ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset
|
|
108
124
|
*TrieveRubyClient::ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group
|
|
109
125
|
*TrieveRubyClient::ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups
|
|
110
126
|
*TrieveRubyClient::ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group
|
|
111
127
|
*TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
|
|
112
128
|
*TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
|
|
129
|
+
*TrieveRubyClient::DatasetApi* | [**clear_dataset**](docs/DatasetApi.md#clear_dataset) | **PUT** /api/dataset/clear/{dataset_id} | Clear Dataset
|
|
113
130
|
*TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
|
|
114
131
|
*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
|
|
115
|
-
*TrieveRubyClient::DatasetApi* | [**
|
|
132
|
+
*TrieveRubyClient::DatasetApi* | [**delete_dataset_by_tracking_id**](docs/DatasetApi.md#delete_dataset_by_tracking_id) | **DELETE** /api/dataset/tracking_id/{tracking_id} | Delete Dataset by Tracking ID
|
|
116
133
|
*TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
|
|
117
134
|
*TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
|
|
135
|
+
*TrieveRubyClient::DatasetApi* | [**get_usage_by_dataset_id**](docs/DatasetApi.md#get_usage_by_dataset_id) | **GET** /api/dataset/usage/{dataset_id} | Get Usage By Dataset ID
|
|
118
136
|
*TrieveRubyClient::DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset
|
|
119
137
|
*TrieveRubyClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset
|
|
120
138
|
*TrieveRubyClient::FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File
|
|
@@ -123,18 +141,21 @@ Class | Method | HTTP request | Description
|
|
|
123
141
|
*TrieveRubyClient::FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | Upload File
|
|
124
142
|
*TrieveRubyClient::HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | Health Check
|
|
125
143
|
*TrieveRubyClient::InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | Send Invitation
|
|
126
|
-
*TrieveRubyClient::MessageApi* | [**
|
|
127
|
-
*TrieveRubyClient::MessageApi* | [**
|
|
144
|
+
*TrieveRubyClient::MessageApi* | [**create_message**](docs/MessageApi.md#create_message) | **POST** /api/message | Create message
|
|
145
|
+
*TrieveRubyClient::MessageApi* | [**edit_message**](docs/MessageApi.md#edit_message) | **PUT** /api/message | Edit message
|
|
128
146
|
*TrieveRubyClient::MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic
|
|
129
|
-
*TrieveRubyClient::MessageApi* | [**
|
|
147
|
+
*TrieveRubyClient::MessageApi* | [**regenerate_message**](docs/MessageApi.md#regenerate_message) | **DELETE** /api/message | Regenerate message
|
|
148
|
+
*TrieveRubyClient::MetricsApi* | [**get_metrics**](docs/MetricsApi.md#get_metrics) | **POST** /metrics | Get Prometheus Metrics
|
|
130
149
|
*TrieveRubyClient::OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization
|
|
131
|
-
*TrieveRubyClient::OrganizationApi* | [**
|
|
132
|
-
*TrieveRubyClient::OrganizationApi* | [**
|
|
150
|
+
*TrieveRubyClient::OrganizationApi* | [**delete_organization**](docs/OrganizationApi.md#delete_organization) | **DELETE** /api/organization/{organization_id} | Delete Organization
|
|
151
|
+
*TrieveRubyClient::OrganizationApi* | [**get_organization**](docs/OrganizationApi.md#get_organization) | **GET** /api/organization/{organization_id} | Get Organization
|
|
133
152
|
*TrieveRubyClient::OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage
|
|
134
153
|
*TrieveRubyClient::OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | Get Organization Users
|
|
135
154
|
*TrieveRubyClient::OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | Update Organization
|
|
136
155
|
*TrieveRubyClient::StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription
|
|
156
|
+
*TrieveRubyClient::StripeApi* | [**create_setup_checkout_session**](docs/StripeApi.md#create_setup_checkout_session) | **POST** /api/stripe/checkout/setup/{organization_id} | Create checkout session setup
|
|
137
157
|
*TrieveRubyClient::StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout
|
|
158
|
+
*TrieveRubyClient::StripeApi* | [**get_all_invoices**](docs/StripeApi.md#get_all_invoices) | **GET** /api/stripe/invoices/{organization_id} | Get All Invoices
|
|
138
159
|
*TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
|
|
139
160
|
*TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan
|
|
140
161
|
*TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic
|
|
@@ -148,94 +169,178 @@ Class | Method | HTTP request | Description
|
|
|
148
169
|
|
|
149
170
|
## Documentation for Models
|
|
150
171
|
|
|
172
|
+
- [TrieveRubyClient::APIVersion](docs/APIVersion.md)
|
|
151
173
|
- [TrieveRubyClient::AddChunkToGroupData](docs/AddChunkToGroupData.md)
|
|
152
|
-
- [TrieveRubyClient::
|
|
174
|
+
- [TrieveRubyClient::ApiKeyRespBody](docs/ApiKeyRespBody.md)
|
|
153
175
|
- [TrieveRubyClient::AuthQuery](docs/AuthQuery.md)
|
|
176
|
+
- [TrieveRubyClient::AutocompleteReqPayload](docs/AutocompleteReqPayload.md)
|
|
154
177
|
- [TrieveRubyClient::BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)
|
|
155
|
-
- [TrieveRubyClient::
|
|
178
|
+
- [TrieveRubyClient::BookmarkGroupResponse](docs/BookmarkGroupResponse.md)
|
|
156
179
|
- [TrieveRubyClient::BookmarkGroupResult](docs/BookmarkGroupResult.md)
|
|
180
|
+
- [TrieveRubyClient::BoostPhrase](docs/BoostPhrase.md)
|
|
157
181
|
- [TrieveRubyClient::ChatMessageProxy](docs/ChatMessageProxy.md)
|
|
158
|
-
- [TrieveRubyClient::ChunkData](docs/ChunkData.md)
|
|
159
182
|
- [TrieveRubyClient::ChunkFilter](docs/ChunkFilter.md)
|
|
160
183
|
- [TrieveRubyClient::ChunkGroup](docs/ChunkGroup.md)
|
|
161
|
-
- [TrieveRubyClient::
|
|
184
|
+
- [TrieveRubyClient::ChunkGroupAndFileId](docs/ChunkGroupAndFileId.md)
|
|
162
185
|
- [TrieveRubyClient::ChunkMetadata](docs/ChunkMetadata.md)
|
|
186
|
+
- [TrieveRubyClient::ChunkMetadataStringTagSet](docs/ChunkMetadataStringTagSet.md)
|
|
187
|
+
- [TrieveRubyClient::ChunkMetadataTypes](docs/ChunkMetadataTypes.md)
|
|
163
188
|
- [TrieveRubyClient::ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)
|
|
164
|
-
- [TrieveRubyClient::
|
|
165
|
-
- [TrieveRubyClient::
|
|
166
|
-
- [TrieveRubyClient::
|
|
189
|
+
- [TrieveRubyClient::ChunkReqPayload](docs/ChunkReqPayload.md)
|
|
190
|
+
- [TrieveRubyClient::ChunkReturnTypes](docs/ChunkReturnTypes.md)
|
|
191
|
+
- [TrieveRubyClient::ClusterAnalytics](docs/ClusterAnalytics.md)
|
|
192
|
+
- [TrieveRubyClient::ClusterAnalyticsFilter](docs/ClusterAnalyticsFilter.md)
|
|
193
|
+
- [TrieveRubyClient::ClusterAnalyticsResponse](docs/ClusterAnalyticsResponse.md)
|
|
194
|
+
- [TrieveRubyClient::ClusterQueries](docs/ClusterQueries.md)
|
|
195
|
+
- [TrieveRubyClient::ClusterTopics](docs/ClusterTopics.md)
|
|
196
|
+
- [TrieveRubyClient::ConditionType](docs/ConditionType.md)
|
|
197
|
+
- [TrieveRubyClient::ContentChunkMetadata](docs/ContentChunkMetadata.md)
|
|
198
|
+
- [TrieveRubyClient::CountChunkQueryResponseBody](docs/CountChunkQueryResponseBody.md)
|
|
199
|
+
- [TrieveRubyClient::CountChunksReqPayload](docs/CountChunksReqPayload.md)
|
|
200
|
+
- [TrieveRubyClient::CountQueries](docs/CountQueries.md)
|
|
201
|
+
- [TrieveRubyClient::CreateChunkGroupReqPayload](docs/CreateChunkGroupReqPayload.md)
|
|
202
|
+
- [TrieveRubyClient::CreateChunkReqPayloadEnum](docs/CreateChunkReqPayloadEnum.md)
|
|
167
203
|
- [TrieveRubyClient::CreateDatasetRequest](docs/CreateDatasetRequest.md)
|
|
168
|
-
- [TrieveRubyClient::
|
|
204
|
+
- [TrieveRubyClient::CreateMessageReqPayload](docs/CreateMessageReqPayload.md)
|
|
169
205
|
- [TrieveRubyClient::CreateOrganizationData](docs/CreateOrganizationData.md)
|
|
170
|
-
- [TrieveRubyClient::
|
|
206
|
+
- [TrieveRubyClient::CreateSetupCheckoutSessionResPayload](docs/CreateSetupCheckoutSessionResPayload.md)
|
|
207
|
+
- [TrieveRubyClient::CreateTopicReqPayload](docs/CreateTopicReqPayload.md)
|
|
171
208
|
- [TrieveRubyClient::Dataset](docs/Dataset.md)
|
|
209
|
+
- [TrieveRubyClient::DatasetAnalytics](docs/DatasetAnalytics.md)
|
|
172
210
|
- [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
|
|
173
211
|
- [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
|
|
174
212
|
- [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
|
|
213
|
+
- [TrieveRubyClient::DateRange](docs/DateRange.md)
|
|
175
214
|
- [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
|
|
176
215
|
- [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
|
|
177
|
-
- [TrieveRubyClient::
|
|
216
|
+
- [TrieveRubyClient::DeprecatedSearchOverGroupsResponseBody](docs/DeprecatedSearchOverGroupsResponseBody.md)
|
|
217
|
+
- [TrieveRubyClient::DistancePhrase](docs/DistancePhrase.md)
|
|
218
|
+
- [TrieveRubyClient::EditMessageReqPayload](docs/EditMessageReqPayload.md)
|
|
178
219
|
- [TrieveRubyClient::ErrorResponseBody](docs/ErrorResponseBody.md)
|
|
179
220
|
- [TrieveRubyClient::Event](docs/Event.md)
|
|
180
221
|
- [TrieveRubyClient::EventReturn](docs/EventReturn.md)
|
|
222
|
+
- [TrieveRubyClient::EventTypeRequest](docs/EventTypeRequest.md)
|
|
181
223
|
- [TrieveRubyClient::FieldCondition](docs/FieldCondition.md)
|
|
182
224
|
- [TrieveRubyClient::File](docs/File.md)
|
|
183
225
|
- [TrieveRubyClient::FileDTO](docs/FileDTO.md)
|
|
184
226
|
- [TrieveRubyClient::GenerateChunksRequest](docs/GenerateChunksRequest.md)
|
|
185
227
|
- [TrieveRubyClient::GeoInfo](docs/GeoInfo.md)
|
|
228
|
+
- [TrieveRubyClient::GeoInfoWithBias](docs/GeoInfoWithBias.md)
|
|
186
229
|
- [TrieveRubyClient::GeoTypes](docs/GeoTypes.md)
|
|
187
230
|
- [TrieveRubyClient::GetChunksData](docs/GetChunksData.md)
|
|
231
|
+
- [TrieveRubyClient::GetChunksForGroupsResponse](docs/GetChunksForGroupsResponse.md)
|
|
232
|
+
- [TrieveRubyClient::GetDatasetsPagination](docs/GetDatasetsPagination.md)
|
|
188
233
|
- [TrieveRubyClient::GetEventsData](docs/GetEventsData.md)
|
|
189
234
|
- [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
|
|
190
235
|
- [TrieveRubyClient::GetTrackingChunksData](docs/GetTrackingChunksData.md)
|
|
236
|
+
- [TrieveRubyClient::Granularity](docs/Granularity.md)
|
|
191
237
|
- [TrieveRubyClient::GroupData](docs/GroupData.md)
|
|
192
238
|
- [TrieveRubyClient::GroupScoreChunk](docs/GroupScoreChunk.md)
|
|
193
|
-
- [TrieveRubyClient::
|
|
239
|
+
- [TrieveRubyClient::GroupsBookmarkQueryResult](docs/GroupsBookmarkQueryResult.md)
|
|
240
|
+
- [TrieveRubyClient::HasIDCondition](docs/HasIDCondition.md)
|
|
241
|
+
- [TrieveRubyClient::HeadQueries](docs/HeadQueries.md)
|
|
242
|
+
- [TrieveRubyClient::HeadQueries1](docs/HeadQueries1.md)
|
|
243
|
+
- [TrieveRubyClient::HeadQueryResponse](docs/HeadQueryResponse.md)
|
|
194
244
|
- [TrieveRubyClient::InvitationData](docs/InvitationData.md)
|
|
245
|
+
- [TrieveRubyClient::LatencyGraph](docs/LatencyGraph.md)
|
|
246
|
+
- [TrieveRubyClient::LatencyGraphResponse](docs/LatencyGraphResponse.md)
|
|
195
247
|
- [TrieveRubyClient::LocationBoundingBox](docs/LocationBoundingBox.md)
|
|
196
248
|
- [TrieveRubyClient::LocationPolygon](docs/LocationPolygon.md)
|
|
197
249
|
- [TrieveRubyClient::LocationRadius](docs/LocationRadius.md)
|
|
250
|
+
- [TrieveRubyClient::LowConfidenceQueries](docs/LowConfidenceQueries.md)
|
|
251
|
+
- [TrieveRubyClient::LowConfidenceRecommendations](docs/LowConfidenceRecommendations.md)
|
|
198
252
|
- [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
|
|
199
253
|
- [TrieveRubyClient::Message](docs/Message.md)
|
|
254
|
+
- [TrieveRubyClient::NewChunkMetadataTypes](docs/NewChunkMetadataTypes.md)
|
|
255
|
+
- [TrieveRubyClient::NoResultQueries](docs/NoResultQueries.md)
|
|
200
256
|
- [TrieveRubyClient::Organization](docs/Organization.md)
|
|
201
257
|
- [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
|
|
258
|
+
- [TrieveRubyClient::QueryCountResponse](docs/QueryCountResponse.md)
|
|
259
|
+
- [TrieveRubyClient::QueryDetails](docs/QueryDetails.md)
|
|
260
|
+
- [TrieveRubyClient::RAGAnalytics](docs/RAGAnalytics.md)
|
|
261
|
+
- [TrieveRubyClient::RAGAnalyticsFilter](docs/RAGAnalyticsFilter.md)
|
|
262
|
+
- [TrieveRubyClient::RAGAnalyticsResponse](docs/RAGAnalyticsResponse.md)
|
|
263
|
+
- [TrieveRubyClient::RAGQueries](docs/RAGQueries.md)
|
|
264
|
+
- [TrieveRubyClient::RAGUsage](docs/RAGUsage.md)
|
|
265
|
+
- [TrieveRubyClient::RAGUsageResponse](docs/RAGUsageResponse.md)
|
|
266
|
+
- [TrieveRubyClient::RPSGraph](docs/RPSGraph.md)
|
|
267
|
+
- [TrieveRubyClient::RPSGraphResponse](docs/RPSGraphResponse.md)
|
|
268
|
+
- [TrieveRubyClient::RagQueryEvent](docs/RagQueryEvent.md)
|
|
269
|
+
- [TrieveRubyClient::RagQueryResponse](docs/RagQueryResponse.md)
|
|
270
|
+
- [TrieveRubyClient::RagTypes](docs/RagTypes.md)
|
|
202
271
|
- [TrieveRubyClient::Range](docs/Range.md)
|
|
203
272
|
- [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
|
|
204
273
|
- [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
|
|
274
|
+
- [TrieveRubyClient::RecommendChunksResponseBody](docs/RecommendChunksResponseBody.md)
|
|
205
275
|
- [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
|
|
206
|
-
- [TrieveRubyClient::
|
|
276
|
+
- [TrieveRubyClient::RecommendGroupsResponse](docs/RecommendGroupsResponse.md)
|
|
277
|
+
- [TrieveRubyClient::RecommendGroupsResponseBody](docs/RecommendGroupsResponseBody.md)
|
|
278
|
+
- [TrieveRubyClient::RecommendResponseTypes](docs/RecommendResponseTypes.md)
|
|
279
|
+
- [TrieveRubyClient::RecommendType](docs/RecommendType.md)
|
|
280
|
+
- [TrieveRubyClient::RecommendationAnalytics](docs/RecommendationAnalytics.md)
|
|
281
|
+
- [TrieveRubyClient::RecommendationAnalyticsFilter](docs/RecommendationAnalyticsFilter.md)
|
|
282
|
+
- [TrieveRubyClient::RecommendationAnalyticsResponse](docs/RecommendationAnalyticsResponse.md)
|
|
283
|
+
- [TrieveRubyClient::RecommendationEvent](docs/RecommendationEvent.md)
|
|
284
|
+
- [TrieveRubyClient::RecommendationQueries](docs/RecommendationQueries.md)
|
|
285
|
+
- [TrieveRubyClient::RecommendationStrategy](docs/RecommendationStrategy.md)
|
|
286
|
+
- [TrieveRubyClient::RecommendationType](docs/RecommendationType.md)
|
|
287
|
+
- [TrieveRubyClient::RecommendationsEventResponse](docs/RecommendationsEventResponse.md)
|
|
288
|
+
- [TrieveRubyClient::RegenerateMessageReqPayload](docs/RegenerateMessageReqPayload.md)
|
|
289
|
+
- [TrieveRubyClient::RemoveChunkFromGroupReqPayload](docs/RemoveChunkFromGroupReqPayload.md)
|
|
207
290
|
- [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
|
|
291
|
+
- [TrieveRubyClient::RoleProxy](docs/RoleProxy.md)
|
|
292
|
+
- [TrieveRubyClient::ScoreChunk](docs/ScoreChunk.md)
|
|
208
293
|
- [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)
|
|
209
|
-
- [TrieveRubyClient::
|
|
210
|
-
- [TrieveRubyClient::
|
|
294
|
+
- [TrieveRubyClient::SearchAnalytics](docs/SearchAnalytics.md)
|
|
295
|
+
- [TrieveRubyClient::SearchAnalyticsFilter](docs/SearchAnalyticsFilter.md)
|
|
296
|
+
- [TrieveRubyClient::SearchAnalyticsResponse](docs/SearchAnalyticsResponse.md)
|
|
211
297
|
- [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
|
|
298
|
+
- [TrieveRubyClient::SearchChunksReqPayload](docs/SearchChunksReqPayload.md)
|
|
299
|
+
- [TrieveRubyClient::SearchClusterResponse](docs/SearchClusterResponse.md)
|
|
300
|
+
- [TrieveRubyClient::SearchClusterTopics](docs/SearchClusterTopics.md)
|
|
301
|
+
- [TrieveRubyClient::SearchGroupResponseTypes](docs/SearchGroupResponseTypes.md)
|
|
302
|
+
- [TrieveRubyClient::SearchLatencyGraph](docs/SearchLatencyGraph.md)
|
|
303
|
+
- [TrieveRubyClient::SearchMethod](docs/SearchMethod.md)
|
|
304
|
+
- [TrieveRubyClient::SearchMetrics](docs/SearchMetrics.md)
|
|
212
305
|
- [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
|
|
306
|
+
- [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)
|
|
307
|
+
- [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)
|
|
213
308
|
- [TrieveRubyClient::SearchOverGroupsResults](docs/SearchOverGroupsResults.md)
|
|
214
|
-
- [TrieveRubyClient::
|
|
215
|
-
- [TrieveRubyClient::
|
|
309
|
+
- [TrieveRubyClient::SearchQueries](docs/SearchQueries.md)
|
|
310
|
+
- [TrieveRubyClient::SearchQueryEvent](docs/SearchQueryEvent.md)
|
|
311
|
+
- [TrieveRubyClient::SearchQueryResponse](docs/SearchQueryResponse.md)
|
|
312
|
+
- [TrieveRubyClient::SearchRPSGraph](docs/SearchRPSGraph.md)
|
|
313
|
+
- [TrieveRubyClient::SearchResponseBody](docs/SearchResponseBody.md)
|
|
314
|
+
- [TrieveRubyClient::SearchResponseTypes](docs/SearchResponseTypes.md)
|
|
315
|
+
- [TrieveRubyClient::SearchResultType](docs/SearchResultType.md)
|
|
316
|
+
- [TrieveRubyClient::SearchType](docs/SearchType.md)
|
|
317
|
+
- [TrieveRubyClient::SearchTypeCount](docs/SearchTypeCount.md)
|
|
216
318
|
- [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
|
|
319
|
+
- [TrieveRubyClient::SearchWithinGroupResponseBody](docs/SearchWithinGroupResponseBody.md)
|
|
217
320
|
- [TrieveRubyClient::SearchWithinGroupResults](docs/SearchWithinGroupResults.md)
|
|
218
|
-
- [TrieveRubyClient::SearchWithinGroupSlimResults](docs/SearchWithinGroupSlimResults.md)
|
|
219
321
|
- [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
|
|
220
322
|
- [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
|
|
221
323
|
- [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
|
|
222
324
|
- [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)
|
|
325
|
+
- [TrieveRubyClient::SlimChunkMetadataWithArrayTagSet](docs/SlimChunkMetadataWithArrayTagSet.md)
|
|
223
326
|
- [TrieveRubyClient::SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)
|
|
224
|
-
- [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
|
|
225
327
|
- [TrieveRubyClient::SlimUser](docs/SlimUser.md)
|
|
328
|
+
- [TrieveRubyClient::SortBy](docs/SortBy.md)
|
|
329
|
+
- [TrieveRubyClient::SortOrder](docs/SortOrder.md)
|
|
330
|
+
- [TrieveRubyClient::StripeInvoice](docs/StripeInvoice.md)
|
|
226
331
|
- [TrieveRubyClient::StripePlan](docs/StripePlan.md)
|
|
227
|
-
- [TrieveRubyClient::
|
|
332
|
+
- [TrieveRubyClient::SuggestedQueriesReqPayload](docs/SuggestedQueriesReqPayload.md)
|
|
228
333
|
- [TrieveRubyClient::SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)
|
|
229
334
|
- [TrieveRubyClient::Topic](docs/Topic.md)
|
|
230
335
|
- [TrieveRubyClient::UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)
|
|
231
|
-
- [TrieveRubyClient::UpdateChunkData](docs/UpdateChunkData.md)
|
|
232
336
|
- [TrieveRubyClient::UpdateChunkGroupData](docs/UpdateChunkGroupData.md)
|
|
337
|
+
- [TrieveRubyClient::UpdateChunkReqPayload](docs/UpdateChunkReqPayload.md)
|
|
233
338
|
- [TrieveRubyClient::UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
|
|
234
|
-
- [TrieveRubyClient::
|
|
339
|
+
- [TrieveRubyClient::UpdateGroupByTrackingIDReqPayload](docs/UpdateGroupByTrackingIDReqPayload.md)
|
|
235
340
|
- [TrieveRubyClient::UpdateOrganizationData](docs/UpdateOrganizationData.md)
|
|
236
|
-
- [TrieveRubyClient::
|
|
341
|
+
- [TrieveRubyClient::UpdateTopicReqPayload](docs/UpdateTopicReqPayload.md)
|
|
237
342
|
- [TrieveRubyClient::UpdateUserOrgRoleData](docs/UpdateUserOrgRoleData.md)
|
|
238
|
-
- [TrieveRubyClient::
|
|
343
|
+
- [TrieveRubyClient::UploadFileReqPayload](docs/UploadFileReqPayload.md)
|
|
239
344
|
- [TrieveRubyClient::UploadFileResult](docs/UploadFileResult.md)
|
|
240
345
|
- [TrieveRubyClient::UserOrganization](docs/UserOrganization.md)
|
|
241
346
|
|
|
@@ -251,3 +356,10 @@ Authentication schemes defined for the API:
|
|
|
251
356
|
- **API key parameter name**: Authorization
|
|
252
357
|
- **Location**: HTTP header
|
|
253
358
|
|
|
359
|
+
### X-API-KEY
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
- **Type**: API key
|
|
363
|
+
- **API key parameter name**: X-API-KEY
|
|
364
|
+
- **Location**: HTTP header
|
|
365
|
+
|
data/docs/APIVersion.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# TrieveRubyClient::APIVersion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'trieve_ruby_client'
|
|
12
|
+
|
|
13
|
+
instance = TrieveRubyClient::APIVersion.new()
|
|
14
|
+
```
|
|
15
|
+
|