trieve-client 0.11.7

Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
pub mod add_chunk_to_group_req_payload;
pub use self::add_chunk_to_group_req_payload::AddChunkToGroupReqPayload;
pub mod api_key_resp_body;
pub use self::api_key_resp_body::ApiKeyRespBody;
pub mod api_version;
pub use self::api_version::ApiVersion;
pub mod auth_query;
pub use self::auth_query::AuthQuery;
pub mod autocomplete_req_payload;
pub use self::autocomplete_req_payload::AutocompleteReqPayload;
pub mod batch_queued_chunk_response;
pub use self::batch_queued_chunk_response::BatchQueuedChunkResponse;
pub mod chat_message_proxy;
pub use self::chat_message_proxy::ChatMessageProxy;
pub mod chunk_filter;
pub use self::chunk_filter::ChunkFilter;
pub mod chunk_group;
pub use self::chunk_group::ChunkGroup;
pub mod chunk_group_and_file_id;
pub use self::chunk_group_and_file_id::ChunkGroupAndFileId;
pub mod chunk_metadata;
pub use self::chunk_metadata::ChunkMetadata;
pub mod chunk_metadata_string_tag_set;
pub use self::chunk_metadata_string_tag_set::ChunkMetadataStringTagSet;
pub mod chunk_metadata_types;
pub use self::chunk_metadata_types::ChunkMetadataTypes;
pub mod chunk_metadata_with_score;
pub use self::chunk_metadata_with_score::ChunkMetadataWithScore;
pub mod chunk_req_payload;
pub use self::chunk_req_payload::ChunkReqPayload;
pub mod chunk_return_types;
pub use self::chunk_return_types::ChunkReturnTypes;
pub mod cluster_analytics;
pub use self::cluster_analytics::ClusterAnalytics;
pub mod cluster_analytics_filter;
pub use self::cluster_analytics_filter::ClusterAnalyticsFilter;
pub mod cluster_analytics_response;
pub use self::cluster_analytics_response::ClusterAnalyticsResponse;
pub mod cluster_queries;
pub use self::cluster_queries::ClusterQueries;
pub mod cluster_topics;
pub use self::cluster_topics::ClusterTopics;
pub mod condition_type;
pub use self::condition_type::ConditionType;
pub mod content_chunk_metadata;
pub use self::content_chunk_metadata::ContentChunkMetadata;
pub mod count_chunk_query_response_body;
pub use self::count_chunk_query_response_body::CountChunkQueryResponseBody;
pub mod count_chunks_req_payload;
pub use self::count_chunks_req_payload::CountChunksReqPayload;
pub mod count_queries;
pub use self::count_queries::CountQueries;
pub mod count_search_method;
pub use self::count_search_method::CountSearchMethod;
pub mod create_chunk_group_req_payload_enum;
pub use self::create_chunk_group_req_payload_enum::CreateChunkGroupReqPayloadEnum;
pub mod create_chunk_group_response_enum;
pub use self::create_chunk_group_response_enum::CreateChunkGroupResponseEnum;
pub mod create_chunk_req_payload_enum;
pub use self::create_chunk_req_payload_enum::CreateChunkReqPayloadEnum;
pub mod create_dataset_request;
pub use self::create_dataset_request::CreateDatasetRequest;
pub mod create_message_req_payload;
pub use self::create_message_req_payload::CreateMessageReqPayload;
pub mod create_organization_req_payload;
pub use self::create_organization_req_payload::CreateOrganizationReqPayload;
pub mod create_setup_checkout_session_res_payload;
pub use self::create_setup_checkout_session_res_payload::CreateSetupCheckoutSessionResPayload;
pub mod create_single_chunk_group_req_payload;
pub use self::create_single_chunk_group_req_payload::CreateSingleChunkGroupReqPayload;
pub mod create_topic_req_payload;
pub use self::create_topic_req_payload::CreateTopicReqPayload;
pub mod ctr_analytics;
pub use self::ctr_analytics::CtrAnalytics;
pub mod ctr_analytics_response;
pub use self::ctr_analytics_response::CtrAnalyticsResponse;
pub mod ctr_data_request_body;
pub use self::ctr_data_request_body::CtrDataRequestBody;
pub mod ctr_recommendations_with_clicks_response;
pub use self::ctr_recommendations_with_clicks_response::CtrRecommendationsWithClicksResponse;
pub mod ctr_recommendations_without_clicks_response;
pub use self::ctr_recommendations_without_clicks_response::CtrRecommendationsWithoutClicksResponse;
pub mod ctr_search_query_with_clicks_response;
pub use self::ctr_search_query_with_clicks_response::CtrSearchQueryWithClicksResponse;
pub mod ctr_search_query_without_clicks_response;
pub use self::ctr_search_query_without_clicks_response::CtrSearchQueryWithoutClicksResponse;
pub mod ctr_type;
pub use self::ctr_type::CtrType;
pub mod dataset;
pub use self::dataset::Dataset;
pub mod dataset_analytics;
pub use self::dataset_analytics::DatasetAnalytics;
pub mod dataset_and_usage;
pub use self::dataset_and_usage::DatasetAndUsage;
pub mod dataset_configuration_dto;
pub use self::dataset_configuration_dto::DatasetConfigurationDto;
pub mod dataset_dto;
pub use self::dataset_dto::DatasetDto;
pub mod dataset_usage_count;
pub use self::dataset_usage_count::DatasetUsageCount;
pub mod date_range;
pub use self::date_range::DateRange;
pub mod delete_topic_data;
pub use self::delete_topic_data::DeleteTopicData;
pub mod delete_user_api_key_request;
pub use self::delete_user_api_key_request::DeleteUserApiKeyRequest;
pub mod deprecated_search_over_groups_response_body;
pub use self::deprecated_search_over_groups_response_body::DeprecatedSearchOverGroupsResponseBody;
pub mod distance_metric;
pub use self::distance_metric::DistanceMetric;
pub mod edit_message_req_payload;
pub use self::edit_message_req_payload::EditMessageReqPayload;
pub mod error_response_body;
pub use self::error_response_body::ErrorResponseBody;
pub mod event_return;
pub use self::event_return::EventReturn;
pub mod event_type_request;
pub use self::event_type_request::EventTypeRequest;
pub mod field_condition;
pub use self::field_condition::FieldCondition;
pub mod file;
pub use self::file::File;
pub mod file_dto;
pub use self::file_dto::FileDto;
pub mod full_text_boost;
pub use self::full_text_boost::FullTextBoost;
pub mod generate_off_chunks_req_payload;
pub use self::generate_off_chunks_req_payload::GenerateOffChunksReqPayload;
pub mod geo_info;
pub use self::geo_info::GeoInfo;
pub mod geo_info_with_bias;
pub use self::geo_info_with_bias::GeoInfoWithBias;
pub mod geo_types;
pub use self::geo_types::GeoTypes;
pub mod get_all_tags_req_payload;
pub use self::get_all_tags_req_payload::GetAllTagsReqPayload;
pub mod get_all_tags_response;
pub use self::get_all_tags_response::GetAllTagsResponse;
pub mod get_chunks_data;
pub use self::get_chunks_data::GetChunksData;
pub mod get_chunks_in_group_response;
pub use self::get_chunks_in_group_response::GetChunksInGroupResponse;
pub mod get_chunks_in_groups_response_body;
pub use self::get_chunks_in_groups_response_body::GetChunksInGroupsResponseBody;
pub mod get_datasets_pagination;
pub use self::get_datasets_pagination::GetDatasetsPagination;
pub mod get_events_data;
pub use self::get_events_data::GetEventsData;
pub mod get_groups_for_chunks_req_payload;
pub use self::get_groups_for_chunks_req_payload::GetGroupsForChunksReqPayload;
pub mod get_tracking_chunks_data;
pub use self::get_tracking_chunks_data::GetTrackingChunksData;
pub mod granularity;
pub use self::granularity::Granularity;
pub mod group_data;
pub use self::group_data::GroupData;
pub mod group_score_chunk;
pub use self::group_score_chunk::GroupScoreChunk;
pub mod groups_bookmark_query_result;
pub use self::groups_bookmark_query_result::GroupsBookmarkQueryResult;
pub mod groups_for_chunk;
pub use self::groups_for_chunk::GroupsForChunk;
pub mod has_id_condition;
pub use self::has_id_condition::HasIdCondition;
pub mod head_queries;
pub use self::head_queries::HeadQueries;
pub mod head_queries_1;
pub use self::head_queries_1::HeadQueries1;
pub mod head_query_response;
pub use self::head_query_response::HeadQueryResponse;
pub mod highlight_options;
pub use self::highlight_options::HighlightOptions;
pub mod highlight_strategy;
pub use self::highlight_strategy::HighlightStrategy;
pub mod invitation_data;
pub use self::invitation_data::InvitationData;
pub mod latency_graph;
pub use self::latency_graph::LatencyGraph;
pub mod latency_graph_response;
pub use self::latency_graph_response::LatencyGraphResponse;
pub mod llm_options;
pub use self::llm_options::LlmOptions;
pub mod location_bounding_box;
pub use self::location_bounding_box::LocationBoundingBox;
pub mod location_polygon;
pub use self::location_polygon::LocationPolygon;
pub mod location_radius;
pub use self::location_radius::LocationRadius;
pub mod low_confidence_queries;
pub use self::low_confidence_queries::LowConfidenceQueries;
pub mod low_confidence_recommendations;
pub use self::low_confidence_recommendations::LowConfidenceRecommendations;
pub mod match_condition;
pub use self::match_condition::MatchCondition;
pub mod message;
pub use self::message::Message;
pub mod multi_query;
pub use self::multi_query::MultiQuery;
pub mod new_chunk_metadata_types;
pub use self::new_chunk_metadata_types::NewChunkMetadataTypes;
pub mod no_result_queries;
pub use self::no_result_queries::NoResultQueries;
pub mod organization;
pub use self::organization::Organization;
pub mod organization_usage_count;
pub use self::organization_usage_count::OrganizationUsageCount;
pub mod popular_filters;
pub use self::popular_filters::PopularFilters;
pub mod popular_filters_1;
pub use self::popular_filters_1::PopularFilters1;
pub mod popular_filters_response;
pub use self::popular_filters_response::PopularFiltersResponse;
pub mod qdrant_sort_by;
pub use self::qdrant_sort_by::QdrantSortBy;
pub mod query_count_response;
pub use self::query_count_response::QueryCountResponse;
pub mod query_details;
pub use self::query_details::QueryDetails;
pub mod query_types;
pub use self::query_types::QueryTypes;
pub mod rag_analytics;
pub use self::rag_analytics::RagAnalytics;
pub mod rag_analytics_filter;
pub use self::rag_analytics_filter::RagAnalyticsFilter;
pub mod rag_analytics_response;
pub use self::rag_analytics_response::RagAnalyticsResponse;
pub mod rag_queries;
pub use self::rag_queries::RagQueries;
pub mod rag_query_event;
pub use self::rag_query_event::RagQueryEvent;
pub mod rag_query_response;
pub use self::rag_query_response::RagQueryResponse;
pub mod rag_sort_by;
pub use self::rag_sort_by::RagSortBy;
pub mod rag_types;
pub use self::rag_types::RagTypes;
pub mod rag_usage;
pub use self::rag_usage::RagUsage;
pub mod rag_usage_graph;
pub use self::rag_usage_graph::RagUsageGraph;
pub mod rag_usage_graph_response;
pub use self::rag_usage_graph_response::RagUsageGraphResponse;
pub mod rag_usage_response;
pub use self::rag_usage_response::RagUsageResponse;
pub mod range;
pub use self::range::Range;
pub mod range_condition;
pub use self::range_condition::RangeCondition;
pub mod rate_query_request;
pub use self::rate_query_request::RateQueryRequest;
pub mod re_rank_options;
pub use self::re_rank_options::ReRankOptions;
pub mod recommend_chunks_request;
pub use self::recommend_chunks_request::RecommendChunksRequest;
pub mod recommend_chunks_response_body;
pub use self::recommend_chunks_response_body::RecommendChunksResponseBody;
pub mod recommend_groups_req_payload;
pub use self::recommend_groups_req_payload::RecommendGroupsReqPayload;
pub mod recommend_groups_response;
pub use self::recommend_groups_response::RecommendGroupsResponse;
pub mod recommend_groups_response_body;
pub use self::recommend_groups_response_body::RecommendGroupsResponseBody;
pub mod recommend_response_types;
pub use self::recommend_response_types::RecommendResponseTypes;
pub mod recommend_type;
pub use self::recommend_type::RecommendType;
pub mod recommendation_analytics;
pub use self::recommendation_analytics::RecommendationAnalytics;
pub mod recommendation_analytics_filter;
pub use self::recommendation_analytics_filter::RecommendationAnalyticsFilter;
pub mod recommendation_analytics_response;
pub use self::recommendation_analytics_response::RecommendationAnalyticsResponse;
pub mod recommendation_ctr_metrics;
pub use self::recommendation_ctr_metrics::RecommendationCtrMetrics;
pub mod recommendation_ctr_metrics_1;
pub use self::recommendation_ctr_metrics_1::RecommendationCtrMetrics1;
pub mod recommendation_event;
pub use self::recommendation_event::RecommendationEvent;
pub mod recommendation_queries;
pub use self::recommendation_queries::RecommendationQueries;
pub mod recommendation_strategy;
pub use self::recommendation_strategy::RecommendationStrategy;
pub mod recommendation_type;
pub use self::recommendation_type::RecommendationType;
pub mod recommendations_event_response;
pub use self::recommendations_event_response::RecommendationsEventResponse;
pub mod recommendations_with_clicks;
pub use self::recommendations_with_clicks::RecommendationsWithClicks;
pub mod recommendations_with_clicks_ctr_response;
pub use self::recommendations_with_clicks_ctr_response::RecommendationsWithClicksCtrResponse;
pub mod recommendations_without_clicks;
pub use self::recommendations_without_clicks::RecommendationsWithoutClicks;
pub mod recommendations_without_clicks_ctr_response;
pub use self::recommendations_without_clicks_ctr_response::RecommendationsWithoutClicksCtrResponse;
pub mod regenerate_message_req_payload;
pub use self::regenerate_message_req_payload::RegenerateMessageReqPayload;
pub mod remove_chunk_from_group_req_payload;
pub use self::remove_chunk_from_group_req_payload::RemoveChunkFromGroupReqPayload;
pub mod return_queued_chunk;
pub use self::return_queued_chunk::ReturnQueuedChunk;
pub mod role_proxy;
pub use self::role_proxy::RoleProxy;
pub mod score_chunk;
pub use self::score_chunk::ScoreChunk;
pub mod score_chunk_dto;
pub use self::score_chunk_dto::ScoreChunkDto;
pub mod scroll_chunks_req_payload;
pub use self::scroll_chunks_req_payload::ScrollChunksReqPayload;
pub mod scroll_chunks_response_body;
pub use self::scroll_chunks_response_body::ScrollChunksResponseBody;
pub mod search_analytics;
pub use self::search_analytics::SearchAnalytics;
pub mod search_analytics_filter;
pub use self::search_analytics_filter::SearchAnalyticsFilter;
pub mod search_analytics_response;
pub use self::search_analytics_response::SearchAnalyticsResponse;
pub mod search_chunk_query_response_body;
pub use self::search_chunk_query_response_body::SearchChunkQueryResponseBody;
pub mod search_chunks_req_payload;
pub use self::search_chunks_req_payload::SearchChunksReqPayload;
pub mod search_cluster_response;
pub use self::search_cluster_response::SearchClusterResponse;
pub mod search_cluster_topics;
pub use self::search_cluster_topics::SearchClusterTopics;
pub mod search_ctr_metrics;
pub use self::search_ctr_metrics::SearchCtrMetrics;
pub mod search_ctr_metrics_1;
pub use self::search_ctr_metrics_1::SearchCtrMetrics1;
pub mod search_group_response_types;
pub use self::search_group_response_types::SearchGroupResponseTypes;
pub mod search_latency_graph;
pub use self::search_latency_graph::SearchLatencyGraph;
pub mod search_method;
pub use self::search_method::SearchMethod;
pub mod search_metrics;
pub use self::search_metrics::SearchMetrics;
pub mod search_over_groups_req_payload;
pub use self::search_over_groups_req_payload::SearchOverGroupsReqPayload;
pub mod search_over_groups_response_body;
pub use self::search_over_groups_response_body::SearchOverGroupsResponseBody;
pub mod search_over_groups_response_types;
pub use self::search_over_groups_response_types::SearchOverGroupsResponseTypes;
pub mod search_over_groups_results;
pub use self::search_over_groups_results::SearchOverGroupsResults;
pub mod search_queries;
pub use self::search_queries::SearchQueries;
pub mod search_queries_with_clicks_ctr_response;
pub use self::search_queries_with_clicks_ctr_response::SearchQueriesWithClicksCtrResponse;
pub mod search_queries_without_clicks_ctr_response;
pub use self::search_queries_without_clicks_ctr_response::SearchQueriesWithoutClicksCtrResponse;
pub mod search_query_event;
pub use self::search_query_event::SearchQueryEvent;
pub mod search_query_response;
pub use self::search_query_response::SearchQueryResponse;
pub mod search_response_body;
pub use self::search_response_body::SearchResponseBody;
pub mod search_response_types;
pub use self::search_response_types::SearchResponseTypes;
pub mod search_result_type;
pub use self::search_result_type::SearchResultType;
pub mod search_sort_by;
pub use self::search_sort_by::SearchSortBy;
pub mod search_type;
pub use self::search_type::SearchType;
pub mod search_type_count;
pub use self::search_type_count::SearchTypeCount;
pub mod search_usage_graph;
pub use self::search_usage_graph::SearchUsageGraph;
pub mod search_usage_graph_response;
pub use self::search_usage_graph_response::SearchUsageGraphResponse;
pub mod search_within_group_req_payload;
pub use self::search_within_group_req_payload::SearchWithinGroupReqPayload;
pub mod search_within_group_response_body;
pub use self::search_within_group_response_body::SearchWithinGroupResponseBody;
pub mod search_within_group_results;
pub use self::search_within_group_results::SearchWithinGroupResults;
pub mod searches_with_clicks;
pub use self::searches_with_clicks::SearchesWithClicks;
pub mod searches_without_clicks;
pub use self::searches_without_clicks::SearchesWithoutClicks;
pub mod semantic_boost;
pub use self::semantic_boost::SemanticBoost;
pub mod set_user_api_key_request;
pub use self::set_user_api_key_request::SetUserApiKeyRequest;
pub mod set_user_api_key_response;
pub use self::set_user_api_key_response::SetUserApiKeyResponse;
pub mod single_queued_chunk_response;
pub use self::single_queued_chunk_response::SingleQueuedChunkResponse;
pub mod slim_chunk_metadata;
pub use self::slim_chunk_metadata::SlimChunkMetadata;
pub mod slim_chunk_metadata_with_array_tag_set;
pub use self::slim_chunk_metadata_with_array_tag_set::SlimChunkMetadataWithArrayTagSet;
pub mod slim_chunk_metadata_with_score;
pub use self::slim_chunk_metadata_with_score::SlimChunkMetadataWithScore;
pub mod slim_user;
pub use self::slim_user::SlimUser;
pub mod sort_by_field;
pub use self::sort_by_field::SortByField;
pub mod sort_by_search_type;
pub use self::sort_by_search_type::SortBySearchType;
pub mod sort_options;
pub use self::sort_options::SortOptions;
pub mod sort_order;
pub use self::sort_order::SortOrder;
pub mod stripe_invoice;
pub use self::stripe_invoice::StripeInvoice;
pub mod stripe_plan;
pub use self::stripe_plan::StripePlan;
pub mod suggested_queries_req_payload;
pub use self::suggested_queries_req_payload::SuggestedQueriesReqPayload;
pub mod suggested_queries_response;
pub use self::suggested_queries_response::SuggestedQueriesResponse;
pub mod tags_with_count;
pub use self::tags_with_count::TagsWithCount;
pub mod topic;
pub use self::topic::Topic;
pub mod update_all_org_dataset_configs_req_payload;
pub use self::update_all_org_dataset_configs_req_payload::UpdateAllOrgDatasetConfigsReqPayload;
pub mod update_chunk_by_tracking_id_data;
pub use self::update_chunk_by_tracking_id_data::UpdateChunkByTrackingIdData;
pub mod update_chunk_group_req_payload;
pub use self::update_chunk_group_req_payload::UpdateChunkGroupReqPayload;
pub mod update_chunk_req_payload;
pub use self::update_chunk_req_payload::UpdateChunkReqPayload;
pub mod update_dataset_request;
pub use self::update_dataset_request::UpdateDatasetRequest;
pub mod update_group_by_tracking_id_req_payload;
pub use self::update_group_by_tracking_id_req_payload::UpdateGroupByTrackingIdReqPayload;
pub mod update_organization_req_payload;
pub use self::update_organization_req_payload::UpdateOrganizationReqPayload;
pub mod update_topic_req_payload;
pub use self::update_topic_req_payload::UpdateTopicReqPayload;
pub mod update_user_org_role_data;
pub use self::update_user_org_role_data::UpdateUserOrgRoleData;
pub mod upload_file_req_payload;
pub use self::upload_file_req_payload::UploadFileReqPayload;
pub mod upload_file_result;
pub use self::upload_file_result::UploadFileResult;
pub mod usage_graph_point;
pub use self::usage_graph_point::UsageGraphPoint;
pub mod user_organization;
pub use self::user_organization::UserOrganization;
pub mod worker_event;
pub use self::worker_event::WorkerEvent;