shaped 2.0.1__py3-none-any.whl → 2.0.4__py3-none-any.whl

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.
Files changed (341) hide show
  1. shaped/__init__.py +59 -4
  2. shaped/autogen/__init__.py +527 -66
  3. shaped/autogen/api/__init__.py +4 -3
  4. shaped/autogen/api/engine_api.py +1467 -0
  5. shaped/autogen/api/{dataset_api.py → query_api.py} +159 -194
  6. shaped/autogen/api/table_api.py +1494 -0
  7. shaped/autogen/api/{model_management_api.py → view_api.py} +179 -181
  8. shaped/autogen/api_client.py +18 -11
  9. shaped/autogen/configuration.py +22 -9
  10. shaped/autogen/exceptions.py +25 -5
  11. shaped/autogen/models/__init__.py +247 -52
  12. shaped/autogen/models/ai_enrichment_view_config.py +123 -0
  13. shaped/autogen/models/{path.py → algorithm.py} +19 -19
  14. shaped/autogen/models/amplitude_table_config.py +106 -0
  15. shaped/autogen/models/ascending.py +148 -0
  16. shaped/autogen/models/attn_dropout_prob.py +136 -0
  17. shaped/autogen/models/attribute_journey.py +124 -0
  18. shaped/autogen/models/attribute_value.py +178 -0
  19. shaped/autogen/models/autoscaling_config.py +95 -0
  20. shaped/autogen/models/aws_pinpoint_table_config.py +108 -0
  21. shaped/autogen/models/batch_size.py +136 -0
  22. shaped/autogen/models/batch_size1.py +136 -0
  23. shaped/autogen/models/batch_size2.py +136 -0
  24. shaped/autogen/models/big_query_table_config.py +147 -0
  25. shaped/autogen/models/bm25.py +136 -0
  26. shaped/autogen/models/boosted_reorder_step.py +125 -0
  27. shaped/autogen/models/canary_rollout.py +99 -0
  28. shaped/autogen/models/candidate_attributes_retrieve_step.py +113 -0
  29. shaped/autogen/models/candidate_ids_retrieve_step.py +113 -0
  30. shaped/autogen/models/candidate_retrieval_strategy.py +41 -0
  31. shaped/autogen/models/clickhouse_table_config.py +146 -0
  32. shaped/autogen/models/column_order_retrieve_step.py +123 -0
  33. shaped/autogen/models/column_ordering.py +91 -0
  34. shaped/autogen/models/create_table_response.py +87 -0
  35. shaped/autogen/models/create_view_response.py +87 -0
  36. shaped/autogen/models/custom_table_config.py +135 -0
  37. shaped/autogen/models/data_compute_config.py +89 -0
  38. shaped/autogen/models/data_config.py +145 -0
  39. shaped/autogen/models/data_config_interaction_table.py +146 -0
  40. shaped/autogen/models/data_split_config.py +88 -0
  41. shaped/autogen/models/data_split_strategy.py +37 -0
  42. shaped/autogen/models/data_tier.py +37 -0
  43. shaped/autogen/models/default.py +246 -0
  44. shaped/autogen/models/delete_engine_response.py +87 -0
  45. shaped/autogen/models/delete_table_response.py +87 -0
  46. shaped/autogen/models/delete_view_response.py +87 -0
  47. shaped/autogen/models/deployment_config.py +117 -0
  48. shaped/autogen/models/distance_function.py +38 -0
  49. shaped/autogen/models/diversity_reorder_step.py +137 -0
  50. shaped/autogen/models/dropout_rate.py +136 -0
  51. shaped/autogen/models/dynamo_db_table_config.py +160 -0
  52. shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +138 -0
  53. shaped/autogen/models/embedder_batch_size.py +136 -0
  54. shaped/autogen/models/embedding_config.py +93 -0
  55. shaped/autogen/models/embedding_dim.py +136 -0
  56. shaped/autogen/models/embedding_dims.py +136 -0
  57. shaped/autogen/models/embedding_size.py +136 -0
  58. shaped/autogen/models/encoder.py +140 -0
  59. shaped/autogen/models/encoding_pooling_strategy.py +38 -0
  60. shaped/autogen/models/engine.py +109 -0
  61. shaped/autogen/models/engine_config_v2.py +152 -0
  62. shaped/autogen/models/engine_details_response.py +120 -0
  63. shaped/autogen/models/engine_schema.py +113 -0
  64. shaped/autogen/models/engine_schema_user_inner.py +146 -0
  65. shaped/autogen/models/entity_config.py +109 -0
  66. shaped/autogen/models/entity_journey.py +161 -0
  67. shaped/autogen/models/entity_type.py +38 -0
  68. shaped/autogen/models/evaluation_config.py +92 -0
  69. shaped/autogen/models/exploration_reorder_step.py +125 -0
  70. shaped/autogen/models/expression_filter_step.py +106 -0
  71. shaped/autogen/models/factors.py +136 -0
  72. shaped/autogen/models/factors1.py +136 -0
  73. shaped/autogen/models/feature.py +90 -0
  74. shaped/autogen/models/feature_type.py +60 -0
  75. shaped/autogen/models/file_table_config.py +112 -0
  76. shaped/autogen/models/filter_config.py +99 -0
  77. shaped/autogen/models/filter_dataset.py +164 -0
  78. shaped/autogen/models/filter_index_type.py +36 -0
  79. shaped/autogen/models/filter_retrieve_step.py +113 -0
  80. shaped/autogen/models/filter_step_explanation.py +165 -0
  81. shaped/autogen/models/filter_table.py +140 -0
  82. shaped/autogen/models/filter_type.py +134 -0
  83. shaped/autogen/models/global_filter.py +102 -0
  84. shaped/autogen/models/hidden_dropout_prob.py +136 -0
  85. shaped/autogen/models/hidden_size.py +136 -0
  86. shaped/autogen/models/hidden_size1.py +136 -0
  87. shaped/autogen/models/http_problem_response.py +115 -0
  88. shaped/autogen/models/http_validation_error.py +2 -2
  89. shaped/autogen/models/hugging_face_encoder.py +115 -0
  90. shaped/autogen/models/iceberg_table_config.py +154 -0
  91. shaped/autogen/models/index_config.py +101 -0
  92. shaped/autogen/models/inner_entity_id.py +144 -0
  93. shaped/autogen/models/inner_size.py +136 -0
  94. shaped/autogen/models/inner_size1.py +136 -0
  95. shaped/autogen/models/inner_uid.py +144 -0
  96. shaped/autogen/models/interaction_config.py +122 -0
  97. shaped/autogen/models/interaction_pooling_encoder.py +104 -0
  98. shaped/autogen/models/interaction_round_robin_encoder.py +104 -0
  99. shaped/autogen/models/item_attribute_pooling_encoder.py +111 -0
  100. shaped/autogen/models/journey.py +140 -0
  101. shaped/autogen/models/kafka_table_config.py +129 -0
  102. shaped/autogen/models/kinesis_table_config.py +140 -0
  103. shaped/autogen/models/kinesis_table_config_column_schema_value.py +136 -0
  104. shaped/autogen/models/label.py +90 -0
  105. shaped/autogen/models/label_type.py +36 -0
  106. shaped/autogen/models/laplace_smoothing.py +136 -0
  107. shaped/autogen/models/latency_scaling_policy.py +112 -0
  108. shaped/autogen/models/learning_rate.py +136 -0
  109. shaped/autogen/models/learning_rate1.py +136 -0
  110. shaped/autogen/models/learning_rate2.py +136 -0
  111. shaped/autogen/models/learning_rate3.py +136 -0
  112. shaped/autogen/models/lexical_search_mode.py +99 -0
  113. shaped/autogen/models/list_engines_response.py +95 -0
  114. shaped/autogen/models/list_tables_response.py +95 -0
  115. shaped/autogen/models/list_views_response.py +95 -0
  116. shaped/autogen/models/location_inner.py +138 -0
  117. shaped/autogen/models/loss_types.py +37 -0
  118. shaped/autogen/models/lr.py +136 -0
  119. shaped/autogen/models/lr1.py +136 -0
  120. shaped/autogen/models/lr2.py +136 -0
  121. shaped/autogen/models/max_depth.py +136 -0
  122. shaped/autogen/models/max_leaves.py +136 -0
  123. shaped/autogen/models/max_seq_length.py +136 -0
  124. shaped/autogen/models/max_seq_length1.py +136 -0
  125. shaped/autogen/models/max_seq_length2.py +136 -0
  126. shaped/autogen/models/mode.py +134 -0
  127. shaped/autogen/models/mode1.py +136 -0
  128. shaped/autogen/models/mode2.py +150 -0
  129. shaped/autogen/models/models_inner.py +308 -0
  130. shaped/autogen/models/mongo_db_table_config.py +147 -0
  131. shaped/autogen/models/mssql_table_config.py +155 -0
  132. shaped/autogen/models/{my_sql_dataset_config.py → my_sql_table_config.py} +45 -28
  133. shaped/autogen/models/n_epochs.py +136 -0
  134. shaped/autogen/models/n_epochs1.py +136 -0
  135. shaped/autogen/models/n_epochs2.py +136 -0
  136. shaped/autogen/models/n_estimators.py +136 -0
  137. shaped/autogen/models/n_heads.py +136 -0
  138. shaped/autogen/models/n_layers.py +136 -0
  139. shaped/autogen/models/neg_per_positive.py +136 -0
  140. shaped/autogen/models/negative_samples_count.py +136 -0
  141. shaped/autogen/models/ngram_tokenizer.py +103 -0
  142. shaped/autogen/models/no_op_config.py +117 -0
  143. shaped/autogen/models/num_blocks.py +136 -0
  144. shaped/autogen/models/num_heads.py +136 -0
  145. shaped/autogen/models/num_leaves.py +136 -0
  146. shaped/autogen/models/objective.py +40 -0
  147. shaped/autogen/models/objective1.py +134 -0
  148. shaped/autogen/models/online_store_config.py +89 -0
  149. shaped/autogen/models/pagination_config.py +87 -0
  150. shaped/autogen/models/parameter_definition.py +96 -0
  151. shaped/autogen/models/parameters_value.py +240 -0
  152. shaped/autogen/models/passthrough_score.py +104 -0
  153. shaped/autogen/models/personal_filter.py +104 -0
  154. shaped/autogen/models/pipeline_stage_explanation.py +118 -0
  155. shaped/autogen/models/policy.py +134 -0
  156. shaped/autogen/models/pool_fn.py +152 -0
  157. shaped/autogen/models/pooling_function.py +37 -0
  158. shaped/autogen/models/{postgres_dataset_config.py → postgres_table_config.py} +66 -28
  159. shaped/autogen/models/posthog_table_config.py +133 -0
  160. shaped/autogen/models/prebuilt_filter_step.py +113 -0
  161. shaped/autogen/models/precomputed_item_embedding.py +99 -0
  162. shaped/autogen/models/precomputed_user_embedding.py +99 -0
  163. shaped/autogen/models/query.py +136 -0
  164. shaped/autogen/models/query1.py +136 -0
  165. shaped/autogen/models/query_any_of.py +172 -0
  166. shaped/autogen/models/query_config.py +140 -0
  167. shaped/autogen/models/query_definition.py +106 -0
  168. shaped/autogen/models/query_encoder.py +194 -0
  169. shaped/autogen/models/query_explanation.py +201 -0
  170. shaped/autogen/models/query_request.py +121 -0
  171. shaped/autogen/models/query_result.py +113 -0
  172. shaped/autogen/models/query_table_config.py +99 -0
  173. shaped/autogen/models/rank_item_attribute_values_query_config.py +122 -0
  174. shaped/autogen/models/rank_query_config.py +167 -0
  175. shaped/autogen/models/rank_query_config_filter_inner.py +149 -0
  176. shaped/autogen/models/rank_query_config_reorder_inner.py +186 -0
  177. shaped/autogen/models/rank_query_config_retrieve_inner.py +265 -0
  178. shaped/autogen/models/recreate_rollout.py +97 -0
  179. shaped/autogen/models/{redshift_dataset_config.py → redshift_table_config.py} +48 -25
  180. shaped/autogen/models/reference_table_config.py +113 -0
  181. shaped/autogen/models/regularization.py +136 -0
  182. shaped/autogen/models/reorder_inner.py +149 -0
  183. shaped/autogen/models/reorder_step_explanation.py +207 -0
  184. shaped/autogen/models/request.py +378 -0
  185. shaped/autogen/models/request1.py +140 -0
  186. shaped/autogen/models/requests_per_second_scaling_policy.py +112 -0
  187. shaped/autogen/models/resource_config.py +100 -0
  188. shaped/autogen/models/response_get_view_details_views_view_name_get.py +134 -0
  189. shaped/autogen/models/result.py +132 -0
  190. shaped/autogen/models/result_embeddings_value.py +127 -0
  191. shaped/autogen/models/retrieval_scores_value.py +127 -0
  192. shaped/autogen/models/retrieve_inner.py +196 -0
  193. shaped/autogen/models/retrieve_step_explanation.py +172 -0
  194. shaped/autogen/models/retriever.py +196 -0
  195. shaped/autogen/models/retriever1.py +196 -0
  196. shaped/autogen/models/rollout_config.py +91 -0
  197. shaped/autogen/models/rudderstack_table_config.py +106 -0
  198. shaped/autogen/models/sampling_strategy.py +36 -0
  199. shaped/autogen/models/saved_query_info_response.py +103 -0
  200. shaped/autogen/models/saved_query_list_response.py +87 -0
  201. shaped/autogen/models/saved_query_request.py +115 -0
  202. shaped/autogen/models/schema_config.py +117 -0
  203. shaped/autogen/models/score.py +134 -0
  204. shaped/autogen/models/score_ensemble.py +127 -0
  205. shaped/autogen/models/score_ensemble_policy_config.py +165 -0
  206. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +755 -0
  207. shaped/autogen/models/score_step_explanation.py +224 -0
  208. shaped/autogen/models/search_config.py +105 -0
  209. shaped/autogen/models/segment_table_config.py +106 -0
  210. shaped/autogen/models/sequence_length.py +136 -0
  211. shaped/autogen/models/server_config.py +100 -0
  212. shaped/autogen/models/setup_engine_response.py +87 -0
  213. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +154 -0
  214. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +160 -0
  215. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +215 -0
  216. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +156 -0
  217. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +141 -0
  218. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +211 -0
  219. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +140 -0
  220. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +195 -0
  221. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +245 -0
  222. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +119 -0
  223. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +161 -0
  224. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +108 -0
  225. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +143 -0
  226. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +123 -0
  227. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +230 -0
  228. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +119 -0
  229. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +165 -0
  230. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +153 -0
  231. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +137 -0
  232. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +155 -0
  233. shaped/autogen/models/shopify_table_config.py +156 -0
  234. shaped/autogen/models/similarity_retrieve_step.py +123 -0
  235. shaped/autogen/models/{snowflake_dataset_config.py → snowflake_table_config.py} +47 -18
  236. shaped/autogen/models/sql_transform_type.py +37 -0
  237. shaped/autogen/models/sql_view_config.py +111 -0
  238. shaped/autogen/models/stemmer_tokenizer.py +105 -0
  239. shaped/autogen/models/step_explanation.py +137 -0
  240. shaped/autogen/models/steps_inner.py +179 -0
  241. shaped/autogen/models/strategy.py +134 -0
  242. shaped/autogen/models/table.py +102 -0
  243. shaped/autogen/models/table_deployment_type.py +38 -0
  244. shaped/autogen/models/table_insert_arguments.py +87 -0
  245. shaped/autogen/models/table_insert_response.py +87 -0
  246. shaped/autogen/models/text_encoding.py +148 -0
  247. shaped/autogen/models/text_search_retrieve_step.py +121 -0
  248. shaped/autogen/models/time_frequency.py +136 -0
  249. shaped/autogen/models/time_window.py +136 -0
  250. shaped/autogen/models/time_window_in_days.py +154 -0
  251. shaped/autogen/models/tokenizer.py +149 -0
  252. shaped/autogen/models/trained_model_encoder.py +99 -0
  253. shaped/autogen/models/training_compute_config.py +99 -0
  254. shaped/autogen/models/training_config.py +121 -0
  255. shaped/autogen/models/training_config_models_inner.py +540 -0
  256. shaped/autogen/models/training_strategy.py +37 -0
  257. shaped/autogen/models/transform_status.py +41 -0
  258. shaped/autogen/models/trending_mode.py +37 -0
  259. shaped/autogen/models/truncate_filter_step.py +106 -0
  260. shaped/autogen/models/tunable_bool.py +97 -0
  261. shaped/autogen/models/tunable_float.py +118 -0
  262. shaped/autogen/models/tunable_int.py +118 -0
  263. shaped/autogen/models/tunable_int_categorical.py +99 -0
  264. shaped/autogen/models/tunable_string.py +99 -0
  265. shaped/autogen/models/tuning_config.py +89 -0
  266. shaped/autogen/models/type.py +150 -0
  267. shaped/autogen/models/update_table_response.py +87 -0
  268. shaped/autogen/models/update_view_response.py +87 -0
  269. shaped/autogen/models/user_attribute_pooling_encoder.py +124 -0
  270. shaped/autogen/models/user_inner.py +134 -0
  271. shaped/autogen/models/val_split.py +136 -0
  272. shaped/autogen/models/validation_error.py +13 -3
  273. shaped/autogen/models/validation_error_loc_inner.py +150 -0
  274. shaped/autogen/models/value_type.py +7 -5
  275. shaped/autogen/models/vector_search_mode.py +101 -0
  276. shaped/autogen/models/view.py +104 -0
  277. shaped/autogen/models/view_details_ai.py +140 -0
  278. shaped/autogen/models/view_details_ai_schema_value.py +153 -0
  279. shaped/autogen/models/view_details_sql.py +140 -0
  280. shaped/autogen/models/view_status.py +41 -0
  281. shaped/autogen/models/weight_decay.py +136 -0
  282. shaped/autogen/models/whitespace_tokenizer.py +97 -0
  283. shaped/autogen/models/window_size.py +136 -0
  284. shaped/autogen/rest.py +10 -4
  285. shaped/cli/shaped_cli.py +163 -35
  286. shaped/client.py +591 -171
  287. shaped/config_builders.py +705 -0
  288. shaped/query_builder.py +781 -0
  289. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/METADATA +141 -6
  290. shaped-2.0.4.dist-info/RECORD +296 -0
  291. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/WHEEL +1 -1
  292. shaped-2.0.4.dist-info/entry_points.txt +2 -0
  293. shaped/autogen/api/model_inference_api.py +0 -2825
  294. shaped/autogen/models/amplitude_dataset_config.py +0 -96
  295. shaped/autogen/models/aws_pinpoint_dataset_config.py +0 -96
  296. shaped/autogen/models/big_query_dataset_config.py +0 -114
  297. shaped/autogen/models/complement_items_request.py +0 -99
  298. shaped/autogen/models/complement_items_response.py +0 -89
  299. shaped/autogen/models/connectors_inner.py +0 -134
  300. shaped/autogen/models/create_dataset_arguments.py +0 -263
  301. shaped/autogen/models/create_embedding_response.py +0 -87
  302. shaped/autogen/models/create_item_embedding_request.py +0 -89
  303. shaped/autogen/models/create_model_arguments.py +0 -107
  304. shaped/autogen/models/create_model_response.py +0 -87
  305. shaped/autogen/models/create_user_embedding_request.py +0 -89
  306. shaped/autogen/models/custom_dataset_config.py +0 -115
  307. shaped/autogen/models/dataset_config.py +0 -101
  308. shaped/autogen/models/dataset_schema_type.py +0 -47
  309. shaped/autogen/models/datasets_inner.py +0 -91
  310. shaped/autogen/models/delete_model_response.py +0 -87
  311. shaped/autogen/models/fetch_config.py +0 -95
  312. shaped/autogen/models/file_config.py +0 -105
  313. shaped/autogen/models/file_source_config.py +0 -89
  314. shaped/autogen/models/inference_config.py +0 -101
  315. shaped/autogen/models/insert_model_response.py +0 -87
  316. shaped/autogen/models/interaction.py +0 -87
  317. shaped/autogen/models/list_datasets_response.py +0 -95
  318. shaped/autogen/models/list_models_response.py +0 -95
  319. shaped/autogen/models/model_config.py +0 -99
  320. shaped/autogen/models/model_response.py +0 -95
  321. shaped/autogen/models/mongo_db_dataset_config.py +0 -119
  322. shaped/autogen/models/post_rank_request.py +0 -117
  323. shaped/autogen/models/rank_attribute_response.py +0 -89
  324. shaped/autogen/models/rank_grid_attribute_request.py +0 -91
  325. shaped/autogen/models/rank_grid_attribute_request1.py +0 -93
  326. shaped/autogen/models/rank_grid_attribute_response.py +0 -91
  327. shaped/autogen/models/rank_response.py +0 -91
  328. shaped/autogen/models/retrieve_request.py +0 -101
  329. shaped/autogen/models/retrieve_response.py +0 -91
  330. shaped/autogen/models/retriever_top_k_override.py +0 -97
  331. shaped/autogen/models/rudder_stack_dataset_config.py +0 -96
  332. shaped/autogen/models/segment_dataset_config.py +0 -96
  333. shaped/autogen/models/similar_item_request.py +0 -101
  334. shaped/autogen/models/similar_response.py +0 -89
  335. shaped/autogen/models/similar_users_request.py +0 -99
  336. shaped/autogen/models/successful_response.py +0 -87
  337. shaped/autogen/models/view_model_response.py +0 -99
  338. shaped-2.0.1.dist-info/RECORD +0 -73
  339. shaped-2.0.1.dist-info/entry_points.txt +0 -2
  340. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/top_level.txt +0 -0
  341. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/zip-safe +0 -0
@@ -3,9 +3,9 @@
3
3
  """
4
4
  Shaped API
5
5
 
6
- Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. Shaped's API is composed of 3 components: 1. **Dataset** - used to provision and manage 'Shaped Datasets', which are persisted data views of external data. Shaped Datasets can be created from any of our 'Shaped connectors' (e.g. S3, Segment, Snowflake, etc.) and support both batch ingestion (up to a 15min delay) and stream ingestion (up to a 30 second delay) depending on the specific connector used. Shaped datasets can also be created from local files, which is particularly useful for getting started with a snapshot of data. 2. **Model Management** - used to provision and manage 'Shaped Models', which represent a system of data pipelines, training and serving infrastructure for your ranking use-case. 3. **Model Inference** - a high performance API that's used to make user-understanding requests or ranking inferences to your 'Shaped Models'. For example, the 'rank' endpoint can be used to determine for a given user id query, what is the content that is most engaging to that user. The recommended workflow to interact with the Shaped API is as follows: 1. First create 'Shaped Datasets' to sync over data that your Shaped understanding models will need. The models at the minimum need interaction data to understand behavior of your users, so start with that and add your item and user catalog data later. 2. Then create 'Shaped Models' that use your created 'Shaped Datasets' as input. Your Shaped Model will will start streaming, processing and training from your connected data immediately. After a few hours your model will have tuned all parameters based on your data and will deploy an active model. 3. You can now use the 'Model Inference' endpoints to make real-time inferences to your model based on your use-case.
6
+ Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 1.0.1
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -16,19 +16,19 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
16
  from typing import Any, Dict, List, Optional, Tuple, Union
17
17
  from typing_extensions import Annotated
18
18
 
19
- from pydantic import Field, StrictStr
20
- from typing_extensions import Annotated
21
- from shaped.autogen.models.create_dataset_arguments import CreateDatasetArguments
22
- from shaped.autogen.models.insert_model_response import InsertModelResponse
23
- from shaped.autogen.models.list_datasets_response import ListDatasetsResponse
24
- from shaped.autogen.models.successful_response import SuccessfulResponse
19
+ from pydantic import StrictStr
20
+ from shaped.autogen.models.query_request import QueryRequest
21
+ from shaped.autogen.models.query_result import QueryResult
22
+ from shaped.autogen.models.saved_query_info_response import SavedQueryInfoResponse
23
+ from shaped.autogen.models.saved_query_list_response import SavedQueryListResponse
24
+ from shaped.autogen.models.saved_query_request import SavedQueryRequest
25
25
 
26
26
  from shaped.autogen.api_client import ApiClient, RequestSerialized
27
27
  from shaped.autogen.api_response import ApiResponse
28
28
  from shaped.autogen.rest import RESTResponseType
29
29
 
30
30
 
31
- class DatasetApi:
31
+ class QueryApi:
32
32
  """NOTE: This class is auto generated by OpenAPI Generator
33
33
  Ref: https://openapi-generator.tech
34
34
 
@@ -42,10 +42,9 @@ class DatasetApi:
42
42
 
43
43
 
44
44
  @validate_call
45
- def datasets_create_dataset_post(
45
+ def execute_ad_hoc_query_query_post(
46
46
  self,
47
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
48
- create_dataset_arguments: CreateDatasetArguments,
47
+ query_request: QueryRequest,
49
48
  _request_timeout: Union[
50
49
  None,
51
50
  Annotated[StrictFloat, Field(gt=0)],
@@ -58,15 +57,13 @@ class DatasetApi:
58
57
  _content_type: Optional[StrictStr] = None,
59
58
  _headers: Optional[Dict[StrictStr, Any]] = None,
60
59
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
61
- ) -> SuccessfulResponse:
62
- """Create Dataset
60
+ ) -> QueryResult:
61
+ """Execute Query
63
62
 
64
- Create Dataset is used to provision a 'Shaped Dataset', which is a persisted view of external data. A 'Shaped Dataset' can be hydrated with data using the 'dataset_insert' endpoint. Or you can connect to a batch or streaming connector and we'll ingest the data continuously for you. Batch connectors ingest data at 15minute intervals, stream connectors ingest in real-time. Here are the supported data connectors and their respective data ingestion type: * CUSTOM (batch or stream) * BIGQUERY (batch) * MONGODB (batch) * SNOWFLAKE (batch) * POSTGRES (batch) * MYSQL (batch) * REDSHIFT (batch) * SEGMENT (stream) * RUDDERSTACK (stream) * AMPLITUDE (stream) * AWS_PINPOINT (stream) * KINESIS (stream)
63
+ Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
65
64
 
66
- :param x_api_key: (required)
67
- :type x_api_key: str
68
- :param create_dataset_arguments: (required)
69
- :type create_dataset_arguments: CreateDatasetArguments
65
+ :param query_request: (required)
66
+ :type query_request: QueryRequest
70
67
  :param _request_timeout: timeout setting for this request. If one
71
68
  number provided, it will be total request
72
69
  timeout. It can also be a pair (tuple) of
@@ -89,9 +86,8 @@ class DatasetApi:
89
86
  :return: Returns the result object.
90
87
  """ # noqa: E501
91
88
 
92
- _param = self._datasets_create_dataset_post_serialize(
93
- x_api_key=x_api_key,
94
- create_dataset_arguments=create_dataset_arguments,
89
+ _param = self._execute_ad_hoc_query_query_post_serialize(
90
+ query_request=query_request,
95
91
  _request_auth=_request_auth,
96
92
  _content_type=_content_type,
97
93
  _headers=_headers,
@@ -99,7 +95,7 @@ class DatasetApi:
99
95
  )
100
96
 
101
97
  _response_types_map: Dict[str, Optional[str]] = {
102
- '200': "SuccessfulResponse",
98
+ '200': "QueryResult",
103
99
  '422': "HTTPValidationError",
104
100
  }
105
101
  response_data = self.api_client.call_api(
@@ -114,10 +110,9 @@ class DatasetApi:
114
110
 
115
111
 
116
112
  @validate_call
117
- def datasets_create_dataset_post_with_http_info(
113
+ def execute_ad_hoc_query_query_post_with_http_info(
118
114
  self,
119
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
120
- create_dataset_arguments: CreateDatasetArguments,
115
+ query_request: QueryRequest,
121
116
  _request_timeout: Union[
122
117
  None,
123
118
  Annotated[StrictFloat, Field(gt=0)],
@@ -130,15 +125,13 @@ class DatasetApi:
130
125
  _content_type: Optional[StrictStr] = None,
131
126
  _headers: Optional[Dict[StrictStr, Any]] = None,
132
127
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
133
- ) -> ApiResponse[SuccessfulResponse]:
134
- """Create Dataset
128
+ ) -> ApiResponse[QueryResult]:
129
+ """Execute Query
135
130
 
136
- Create Dataset is used to provision a 'Shaped Dataset', which is a persisted view of external data. A 'Shaped Dataset' can be hydrated with data using the 'dataset_insert' endpoint. Or you can connect to a batch or streaming connector and we'll ingest the data continuously for you. Batch connectors ingest data at 15minute intervals, stream connectors ingest in real-time. Here are the supported data connectors and their respective data ingestion type: * CUSTOM (batch or stream) * BIGQUERY (batch) * MONGODB (batch) * SNOWFLAKE (batch) * POSTGRES (batch) * MYSQL (batch) * REDSHIFT (batch) * SEGMENT (stream) * RUDDERSTACK (stream) * AMPLITUDE (stream) * AWS_PINPOINT (stream) * KINESIS (stream)
131
+ Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
137
132
 
138
- :param x_api_key: (required)
139
- :type x_api_key: str
140
- :param create_dataset_arguments: (required)
141
- :type create_dataset_arguments: CreateDatasetArguments
133
+ :param query_request: (required)
134
+ :type query_request: QueryRequest
142
135
  :param _request_timeout: timeout setting for this request. If one
143
136
  number provided, it will be total request
144
137
  timeout. It can also be a pair (tuple) of
@@ -161,9 +154,8 @@ class DatasetApi:
161
154
  :return: Returns the result object.
162
155
  """ # noqa: E501
163
156
 
164
- _param = self._datasets_create_dataset_post_serialize(
165
- x_api_key=x_api_key,
166
- create_dataset_arguments=create_dataset_arguments,
157
+ _param = self._execute_ad_hoc_query_query_post_serialize(
158
+ query_request=query_request,
167
159
  _request_auth=_request_auth,
168
160
  _content_type=_content_type,
169
161
  _headers=_headers,
@@ -171,7 +163,7 @@ class DatasetApi:
171
163
  )
172
164
 
173
165
  _response_types_map: Dict[str, Optional[str]] = {
174
- '200': "SuccessfulResponse",
166
+ '200': "QueryResult",
175
167
  '422': "HTTPValidationError",
176
168
  }
177
169
  response_data = self.api_client.call_api(
@@ -186,10 +178,9 @@ class DatasetApi:
186
178
 
187
179
 
188
180
  @validate_call
189
- def datasets_create_dataset_post_without_preload_content(
181
+ def execute_ad_hoc_query_query_post_without_preload_content(
190
182
  self,
191
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
192
- create_dataset_arguments: CreateDatasetArguments,
183
+ query_request: QueryRequest,
193
184
  _request_timeout: Union[
194
185
  None,
195
186
  Annotated[StrictFloat, Field(gt=0)],
@@ -203,14 +194,12 @@ class DatasetApi:
203
194
  _headers: Optional[Dict[StrictStr, Any]] = None,
204
195
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
205
196
  ) -> RESTResponseType:
206
- """Create Dataset
197
+ """Execute Query
207
198
 
208
- Create Dataset is used to provision a 'Shaped Dataset', which is a persisted view of external data. A 'Shaped Dataset' can be hydrated with data using the 'dataset_insert' endpoint. Or you can connect to a batch or streaming connector and we'll ingest the data continuously for you. Batch connectors ingest data at 15minute intervals, stream connectors ingest in real-time. Here are the supported data connectors and their respective data ingestion type: * CUSTOM (batch or stream) * BIGQUERY (batch) * MONGODB (batch) * SNOWFLAKE (batch) * POSTGRES (batch) * MYSQL (batch) * REDSHIFT (batch) * SEGMENT (stream) * RUDDERSTACK (stream) * AMPLITUDE (stream) * AWS_PINPOINT (stream) * KINESIS (stream)
199
+ Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
209
200
 
210
- :param x_api_key: (required)
211
- :type x_api_key: str
212
- :param create_dataset_arguments: (required)
213
- :type create_dataset_arguments: CreateDatasetArguments
201
+ :param query_request: (required)
202
+ :type query_request: QueryRequest
214
203
  :param _request_timeout: timeout setting for this request. If one
215
204
  number provided, it will be total request
216
205
  timeout. It can also be a pair (tuple) of
@@ -233,9 +222,8 @@ class DatasetApi:
233
222
  :return: Returns the result object.
234
223
  """ # noqa: E501
235
224
 
236
- _param = self._datasets_create_dataset_post_serialize(
237
- x_api_key=x_api_key,
238
- create_dataset_arguments=create_dataset_arguments,
225
+ _param = self._execute_ad_hoc_query_query_post_serialize(
226
+ query_request=query_request,
239
227
  _request_auth=_request_auth,
240
228
  _content_type=_content_type,
241
229
  _headers=_headers,
@@ -243,7 +231,7 @@ class DatasetApi:
243
231
  )
244
232
 
245
233
  _response_types_map: Dict[str, Optional[str]] = {
246
- '200': "SuccessfulResponse",
234
+ '200': "QueryResult",
247
235
  '422': "HTTPValidationError",
248
236
  }
249
237
  response_data = self.api_client.call_api(
@@ -253,10 +241,9 @@ class DatasetApi:
253
241
  return response_data.response
254
242
 
255
243
 
256
- def _datasets_create_dataset_post_serialize(
244
+ def _execute_ad_hoc_query_query_post_serialize(
257
245
  self,
258
- x_api_key,
259
- create_dataset_arguments,
246
+ query_request,
260
247
  _request_auth,
261
248
  _content_type,
262
249
  _headers,
@@ -280,12 +267,10 @@ class DatasetApi:
280
267
  # process the path parameters
281
268
  # process the query parameters
282
269
  # process the header parameters
283
- if x_api_key is not None:
284
- _header_params['x-api-key'] = x_api_key
285
270
  # process the form parameters
286
271
  # process the body parameter
287
- if create_dataset_arguments is not None:
288
- _body_params = create_dataset_arguments
272
+ if query_request is not None:
273
+ _body_params = query_request
289
274
 
290
275
 
291
276
  # set the HTTP header `Accept`
@@ -316,7 +301,7 @@ class DatasetApi:
316
301
 
317
302
  return self.api_client.param_serialize(
318
303
  method='POST',
319
- resource_path='/datasets/',
304
+ resource_path='/query',
320
305
  path_params=_path_params,
321
306
  query_params=_query_params,
322
307
  header_params=_header_params,
@@ -333,10 +318,10 @@ class DatasetApi:
333
318
 
334
319
 
335
320
  @validate_call
336
- def datasets_dataset_insert_post(
321
+ def execute_saved_query_queries_query_name_post(
337
322
  self,
338
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
339
- dataset_name: StrictStr,
323
+ query_name: StrictStr,
324
+ saved_query_request: SavedQueryRequest,
340
325
  _request_timeout: Union[
341
326
  None,
342
327
  Annotated[StrictFloat, Field(gt=0)],
@@ -349,15 +334,15 @@ class DatasetApi:
349
334
  _content_type: Optional[StrictStr] = None,
350
335
  _headers: Optional[Dict[StrictStr, Any]] = None,
351
336
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
352
- ) -> InsertModelResponse:
353
- """Dataset Insert
337
+ ) -> QueryResult:
338
+ """Execute Saved Query
354
339
 
355
- Dataset insert allows you to push data payloads like events, users or items directly to a Dataset. This is useful for uploading local data to Shaped or inserting real-time data directly from your application.
340
+ Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
356
341
 
357
- :param x_api_key: (required)
358
- :type x_api_key: str
359
- :param dataset_name: (required)
360
- :type dataset_name: str
342
+ :param query_name: (required)
343
+ :type query_name: str
344
+ :param saved_query_request: (required)
345
+ :type saved_query_request: SavedQueryRequest
361
346
  :param _request_timeout: timeout setting for this request. If one
362
347
  number provided, it will be total request
363
348
  timeout. It can also be a pair (tuple) of
@@ -380,9 +365,9 @@ class DatasetApi:
380
365
  :return: Returns the result object.
381
366
  """ # noqa: E501
382
367
 
383
- _param = self._datasets_dataset_insert_post_serialize(
384
- x_api_key=x_api_key,
385
- dataset_name=dataset_name,
368
+ _param = self._execute_saved_query_queries_query_name_post_serialize(
369
+ query_name=query_name,
370
+ saved_query_request=saved_query_request,
386
371
  _request_auth=_request_auth,
387
372
  _content_type=_content_type,
388
373
  _headers=_headers,
@@ -390,7 +375,7 @@ class DatasetApi:
390
375
  )
391
376
 
392
377
  _response_types_map: Dict[str, Optional[str]] = {
393
- '200': "InsertModelResponse",
378
+ '200': "QueryResult",
394
379
  '422': "HTTPValidationError",
395
380
  }
396
381
  response_data = self.api_client.call_api(
@@ -405,10 +390,10 @@ class DatasetApi:
405
390
 
406
391
 
407
392
  @validate_call
408
- def datasets_dataset_insert_post_with_http_info(
393
+ def execute_saved_query_queries_query_name_post_with_http_info(
409
394
  self,
410
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
411
- dataset_name: StrictStr,
395
+ query_name: StrictStr,
396
+ saved_query_request: SavedQueryRequest,
412
397
  _request_timeout: Union[
413
398
  None,
414
399
  Annotated[StrictFloat, Field(gt=0)],
@@ -421,15 +406,15 @@ class DatasetApi:
421
406
  _content_type: Optional[StrictStr] = None,
422
407
  _headers: Optional[Dict[StrictStr, Any]] = None,
423
408
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
424
- ) -> ApiResponse[InsertModelResponse]:
425
- """Dataset Insert
409
+ ) -> ApiResponse[QueryResult]:
410
+ """Execute Saved Query
426
411
 
427
- Dataset insert allows you to push data payloads like events, users or items directly to a Dataset. This is useful for uploading local data to Shaped or inserting real-time data directly from your application.
412
+ Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
428
413
 
429
- :param x_api_key: (required)
430
- :type x_api_key: str
431
- :param dataset_name: (required)
432
- :type dataset_name: str
414
+ :param query_name: (required)
415
+ :type query_name: str
416
+ :param saved_query_request: (required)
417
+ :type saved_query_request: SavedQueryRequest
433
418
  :param _request_timeout: timeout setting for this request. If one
434
419
  number provided, it will be total request
435
420
  timeout. It can also be a pair (tuple) of
@@ -452,9 +437,9 @@ class DatasetApi:
452
437
  :return: Returns the result object.
453
438
  """ # noqa: E501
454
439
 
455
- _param = self._datasets_dataset_insert_post_serialize(
456
- x_api_key=x_api_key,
457
- dataset_name=dataset_name,
440
+ _param = self._execute_saved_query_queries_query_name_post_serialize(
441
+ query_name=query_name,
442
+ saved_query_request=saved_query_request,
458
443
  _request_auth=_request_auth,
459
444
  _content_type=_content_type,
460
445
  _headers=_headers,
@@ -462,7 +447,7 @@ class DatasetApi:
462
447
  )
463
448
 
464
449
  _response_types_map: Dict[str, Optional[str]] = {
465
- '200': "InsertModelResponse",
450
+ '200': "QueryResult",
466
451
  '422': "HTTPValidationError",
467
452
  }
468
453
  response_data = self.api_client.call_api(
@@ -477,10 +462,10 @@ class DatasetApi:
477
462
 
478
463
 
479
464
  @validate_call
480
- def datasets_dataset_insert_post_without_preload_content(
465
+ def execute_saved_query_queries_query_name_post_without_preload_content(
481
466
  self,
482
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
483
- dataset_name: StrictStr,
467
+ query_name: StrictStr,
468
+ saved_query_request: SavedQueryRequest,
484
469
  _request_timeout: Union[
485
470
  None,
486
471
  Annotated[StrictFloat, Field(gt=0)],
@@ -494,14 +479,14 @@ class DatasetApi:
494
479
  _headers: Optional[Dict[StrictStr, Any]] = None,
495
480
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
496
481
  ) -> RESTResponseType:
497
- """Dataset Insert
482
+ """Execute Saved Query
498
483
 
499
- Dataset insert allows you to push data payloads like events, users or items directly to a Dataset. This is useful for uploading local data to Shaped or inserting real-time data directly from your application.
484
+ Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
500
485
 
501
- :param x_api_key: (required)
502
- :type x_api_key: str
503
- :param dataset_name: (required)
504
- :type dataset_name: str
486
+ :param query_name: (required)
487
+ :type query_name: str
488
+ :param saved_query_request: (required)
489
+ :type saved_query_request: SavedQueryRequest
505
490
  :param _request_timeout: timeout setting for this request. If one
506
491
  number provided, it will be total request
507
492
  timeout. It can also be a pair (tuple) of
@@ -524,9 +509,9 @@ class DatasetApi:
524
509
  :return: Returns the result object.
525
510
  """ # noqa: E501
526
511
 
527
- _param = self._datasets_dataset_insert_post_serialize(
528
- x_api_key=x_api_key,
529
- dataset_name=dataset_name,
512
+ _param = self._execute_saved_query_queries_query_name_post_serialize(
513
+ query_name=query_name,
514
+ saved_query_request=saved_query_request,
530
515
  _request_auth=_request_auth,
531
516
  _content_type=_content_type,
532
517
  _headers=_headers,
@@ -534,7 +519,7 @@ class DatasetApi:
534
519
  )
535
520
 
536
521
  _response_types_map: Dict[str, Optional[str]] = {
537
- '200': "InsertModelResponse",
522
+ '200': "QueryResult",
538
523
  '422': "HTTPValidationError",
539
524
  }
540
525
  response_data = self.api_client.call_api(
@@ -544,10 +529,10 @@ class DatasetApi:
544
529
  return response_data.response
545
530
 
546
531
 
547
- def _datasets_dataset_insert_post_serialize(
532
+ def _execute_saved_query_queries_query_name_post_serialize(
548
533
  self,
549
- x_api_key,
550
- dataset_name,
534
+ query_name,
535
+ saved_query_request,
551
536
  _request_auth,
552
537
  _content_type,
553
538
  _headers,
@@ -569,14 +554,14 @@ class DatasetApi:
569
554
  _body_params: Optional[bytes] = None
570
555
 
571
556
  # process the path parameters
572
- if dataset_name is not None:
573
- _path_params['dataset_name'] = dataset_name
557
+ if query_name is not None:
558
+ _path_params['query_name'] = query_name
574
559
  # process the query parameters
575
560
  # process the header parameters
576
- if x_api_key is not None:
577
- _header_params['x-api-key'] = x_api_key
578
561
  # process the form parameters
579
562
  # process the body parameter
563
+ if saved_query_request is not None:
564
+ _body_params = saved_query_request
580
565
 
581
566
 
582
567
  # set the HTTP header `Accept`
@@ -587,6 +572,19 @@ class DatasetApi:
587
572
  ]
588
573
  )
589
574
 
575
+ # set the HTTP header `Content-Type`
576
+ if _content_type:
577
+ _header_params['Content-Type'] = _content_type
578
+ else:
579
+ _default_content_type = (
580
+ self.api_client.select_header_content_type(
581
+ [
582
+ 'application/json'
583
+ ]
584
+ )
585
+ )
586
+ if _default_content_type is not None:
587
+ _header_params['Content-Type'] = _default_content_type
590
588
 
591
589
  # authentication setting
592
590
  _auth_settings: List[str] = [
@@ -594,7 +592,7 @@ class DatasetApi:
594
592
 
595
593
  return self.api_client.param_serialize(
596
594
  method='POST',
597
- resource_path='/datasets/{dataset_name}/insert',
595
+ resource_path='/queries/{query_name}',
598
596
  path_params=_path_params,
599
597
  query_params=_query_params,
600
598
  header_params=_header_params,
@@ -611,10 +609,9 @@ class DatasetApi:
611
609
 
612
610
 
613
611
  @validate_call
614
- def datasets_dataset_name_delete_dataset(
612
+ def get_saved_query_info_queries_query_name_get(
615
613
  self,
616
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
617
- dataset_name: StrictStr,
614
+ query_name: StrictStr,
618
615
  _request_timeout: Union[
619
616
  None,
620
617
  Annotated[StrictFloat, Field(gt=0)],
@@ -627,15 +624,13 @@ class DatasetApi:
627
624
  _content_type: Optional[StrictStr] = None,
628
625
  _headers: Optional[Dict[StrictStr, Any]] = None,
629
626
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
630
- ) -> SuccessfulResponse:
631
- """Delete Dataset
627
+ ) -> SavedQueryInfoResponse:
628
+ """Get Saved Query Details
632
629
 
633
- Delete the dataset with identifier: {dataset_name}.
630
+ Get information about a specific saved query.
634
631
 
635
- :param x_api_key: (required)
636
- :type x_api_key: str
637
- :param dataset_name: (required)
638
- :type dataset_name: str
632
+ :param query_name: (required)
633
+ :type query_name: str
639
634
  :param _request_timeout: timeout setting for this request. If one
640
635
  number provided, it will be total request
641
636
  timeout. It can also be a pair (tuple) of
@@ -658,9 +653,8 @@ class DatasetApi:
658
653
  :return: Returns the result object.
659
654
  """ # noqa: E501
660
655
 
661
- _param = self._datasets_dataset_name_delete_dataset_serialize(
662
- x_api_key=x_api_key,
663
- dataset_name=dataset_name,
656
+ _param = self._get_saved_query_info_queries_query_name_get_serialize(
657
+ query_name=query_name,
664
658
  _request_auth=_request_auth,
665
659
  _content_type=_content_type,
666
660
  _headers=_headers,
@@ -668,7 +662,7 @@ class DatasetApi:
668
662
  )
669
663
 
670
664
  _response_types_map: Dict[str, Optional[str]] = {
671
- '200': "SuccessfulResponse",
665
+ '200': "SavedQueryInfoResponse",
672
666
  '422': "HTTPValidationError",
673
667
  }
674
668
  response_data = self.api_client.call_api(
@@ -683,10 +677,9 @@ class DatasetApi:
683
677
 
684
678
 
685
679
  @validate_call
686
- def datasets_dataset_name_delete_dataset_with_http_info(
680
+ def get_saved_query_info_queries_query_name_get_with_http_info(
687
681
  self,
688
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
689
- dataset_name: StrictStr,
682
+ query_name: StrictStr,
690
683
  _request_timeout: Union[
691
684
  None,
692
685
  Annotated[StrictFloat, Field(gt=0)],
@@ -699,15 +692,13 @@ class DatasetApi:
699
692
  _content_type: Optional[StrictStr] = None,
700
693
  _headers: Optional[Dict[StrictStr, Any]] = None,
701
694
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
702
- ) -> ApiResponse[SuccessfulResponse]:
703
- """Delete Dataset
695
+ ) -> ApiResponse[SavedQueryInfoResponse]:
696
+ """Get Saved Query Details
704
697
 
705
- Delete the dataset with identifier: {dataset_name}.
698
+ Get information about a specific saved query.
706
699
 
707
- :param x_api_key: (required)
708
- :type x_api_key: str
709
- :param dataset_name: (required)
710
- :type dataset_name: str
700
+ :param query_name: (required)
701
+ :type query_name: str
711
702
  :param _request_timeout: timeout setting for this request. If one
712
703
  number provided, it will be total request
713
704
  timeout. It can also be a pair (tuple) of
@@ -730,9 +721,8 @@ class DatasetApi:
730
721
  :return: Returns the result object.
731
722
  """ # noqa: E501
732
723
 
733
- _param = self._datasets_dataset_name_delete_dataset_serialize(
734
- x_api_key=x_api_key,
735
- dataset_name=dataset_name,
724
+ _param = self._get_saved_query_info_queries_query_name_get_serialize(
725
+ query_name=query_name,
736
726
  _request_auth=_request_auth,
737
727
  _content_type=_content_type,
738
728
  _headers=_headers,
@@ -740,7 +730,7 @@ class DatasetApi:
740
730
  )
741
731
 
742
732
  _response_types_map: Dict[str, Optional[str]] = {
743
- '200': "SuccessfulResponse",
733
+ '200': "SavedQueryInfoResponse",
744
734
  '422': "HTTPValidationError",
745
735
  }
746
736
  response_data = self.api_client.call_api(
@@ -755,10 +745,9 @@ class DatasetApi:
755
745
 
756
746
 
757
747
  @validate_call
758
- def datasets_dataset_name_delete_dataset_without_preload_content(
748
+ def get_saved_query_info_queries_query_name_get_without_preload_content(
759
749
  self,
760
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
761
- dataset_name: StrictStr,
750
+ query_name: StrictStr,
762
751
  _request_timeout: Union[
763
752
  None,
764
753
  Annotated[StrictFloat, Field(gt=0)],
@@ -772,14 +761,12 @@ class DatasetApi:
772
761
  _headers: Optional[Dict[StrictStr, Any]] = None,
773
762
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
774
763
  ) -> RESTResponseType:
775
- """Delete Dataset
764
+ """Get Saved Query Details
776
765
 
777
- Delete the dataset with identifier: {dataset_name}.
766
+ Get information about a specific saved query.
778
767
 
779
- :param x_api_key: (required)
780
- :type x_api_key: str
781
- :param dataset_name: (required)
782
- :type dataset_name: str
768
+ :param query_name: (required)
769
+ :type query_name: str
783
770
  :param _request_timeout: timeout setting for this request. If one
784
771
  number provided, it will be total request
785
772
  timeout. It can also be a pair (tuple) of
@@ -802,9 +789,8 @@ class DatasetApi:
802
789
  :return: Returns the result object.
803
790
  """ # noqa: E501
804
791
 
805
- _param = self._datasets_dataset_name_delete_dataset_serialize(
806
- x_api_key=x_api_key,
807
- dataset_name=dataset_name,
792
+ _param = self._get_saved_query_info_queries_query_name_get_serialize(
793
+ query_name=query_name,
808
794
  _request_auth=_request_auth,
809
795
  _content_type=_content_type,
810
796
  _headers=_headers,
@@ -812,7 +798,7 @@ class DatasetApi:
812
798
  )
813
799
 
814
800
  _response_types_map: Dict[str, Optional[str]] = {
815
- '200': "SuccessfulResponse",
801
+ '200': "SavedQueryInfoResponse",
816
802
  '422': "HTTPValidationError",
817
803
  }
818
804
  response_data = self.api_client.call_api(
@@ -822,10 +808,9 @@ class DatasetApi:
822
808
  return response_data.response
823
809
 
824
810
 
825
- def _datasets_dataset_name_delete_dataset_serialize(
811
+ def _get_saved_query_info_queries_query_name_get_serialize(
826
812
  self,
827
- x_api_key,
828
- dataset_name,
813
+ query_name,
829
814
  _request_auth,
830
815
  _content_type,
831
816
  _headers,
@@ -847,12 +832,10 @@ class DatasetApi:
847
832
  _body_params: Optional[bytes] = None
848
833
 
849
834
  # process the path parameters
850
- if dataset_name is not None:
851
- _path_params['dataset_name'] = dataset_name
835
+ if query_name is not None:
836
+ _path_params['query_name'] = query_name
852
837
  # process the query parameters
853
838
  # process the header parameters
854
- if x_api_key is not None:
855
- _header_params['x-api-key'] = x_api_key
856
839
  # process the form parameters
857
840
  # process the body parameter
858
841
 
@@ -871,8 +854,8 @@ class DatasetApi:
871
854
  ]
872
855
 
873
856
  return self.api_client.param_serialize(
874
- method='DELETE',
875
- resource_path='/datasets/{dataset_name}',
857
+ method='GET',
858
+ resource_path='/queries/{query_name}',
876
859
  path_params=_path_params,
877
860
  query_params=_query_params,
878
861
  header_params=_header_params,
@@ -889,9 +872,8 @@ class DatasetApi:
889
872
 
890
873
 
891
874
  @validate_call
892
- def datasets_list_datasets_get(
875
+ def list_saved_queries_queries_get(
893
876
  self,
894
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
895
877
  _request_timeout: Union[
896
878
  None,
897
879
  Annotated[StrictFloat, Field(gt=0)],
@@ -904,13 +886,11 @@ class DatasetApi:
904
886
  _content_type: Optional[StrictStr] = None,
905
887
  _headers: Optional[Dict[StrictStr, Any]] = None,
906
888
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
907
- ) -> ListDatasetsResponse:
908
- """List Datasets
889
+ ) -> SavedQueryListResponse:
890
+ """List Saved Queries
909
891
 
910
- List Datasets returns information about all account datasets including schema and provisioning status.
892
+ List all available saved queries.
911
893
 
912
- :param x_api_key: (required)
913
- :type x_api_key: str
914
894
  :param _request_timeout: timeout setting for this request. If one
915
895
  number provided, it will be total request
916
896
  timeout. It can also be a pair (tuple) of
@@ -933,8 +913,7 @@ class DatasetApi:
933
913
  :return: Returns the result object.
934
914
  """ # noqa: E501
935
915
 
936
- _param = self._datasets_list_datasets_get_serialize(
937
- x_api_key=x_api_key,
916
+ _param = self._list_saved_queries_queries_get_serialize(
938
917
  _request_auth=_request_auth,
939
918
  _content_type=_content_type,
940
919
  _headers=_headers,
@@ -942,8 +921,7 @@ class DatasetApi:
942
921
  )
943
922
 
944
923
  _response_types_map: Dict[str, Optional[str]] = {
945
- '200': "ListDatasetsResponse",
946
- '422': "HTTPValidationError",
924
+ '200': "SavedQueryListResponse",
947
925
  }
948
926
  response_data = self.api_client.call_api(
949
927
  *_param,
@@ -957,9 +935,8 @@ class DatasetApi:
957
935
 
958
936
 
959
937
  @validate_call
960
- def datasets_list_datasets_get_with_http_info(
938
+ def list_saved_queries_queries_get_with_http_info(
961
939
  self,
962
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
963
940
  _request_timeout: Union[
964
941
  None,
965
942
  Annotated[StrictFloat, Field(gt=0)],
@@ -972,13 +949,11 @@ class DatasetApi:
972
949
  _content_type: Optional[StrictStr] = None,
973
950
  _headers: Optional[Dict[StrictStr, Any]] = None,
974
951
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
975
- ) -> ApiResponse[ListDatasetsResponse]:
976
- """List Datasets
952
+ ) -> ApiResponse[SavedQueryListResponse]:
953
+ """List Saved Queries
977
954
 
978
- List Datasets returns information about all account datasets including schema and provisioning status.
955
+ List all available saved queries.
979
956
 
980
- :param x_api_key: (required)
981
- :type x_api_key: str
982
957
  :param _request_timeout: timeout setting for this request. If one
983
958
  number provided, it will be total request
984
959
  timeout. It can also be a pair (tuple) of
@@ -1001,8 +976,7 @@ class DatasetApi:
1001
976
  :return: Returns the result object.
1002
977
  """ # noqa: E501
1003
978
 
1004
- _param = self._datasets_list_datasets_get_serialize(
1005
- x_api_key=x_api_key,
979
+ _param = self._list_saved_queries_queries_get_serialize(
1006
980
  _request_auth=_request_auth,
1007
981
  _content_type=_content_type,
1008
982
  _headers=_headers,
@@ -1010,8 +984,7 @@ class DatasetApi:
1010
984
  )
1011
985
 
1012
986
  _response_types_map: Dict[str, Optional[str]] = {
1013
- '200': "ListDatasetsResponse",
1014
- '422': "HTTPValidationError",
987
+ '200': "SavedQueryListResponse",
1015
988
  }
1016
989
  response_data = self.api_client.call_api(
1017
990
  *_param,
@@ -1025,9 +998,8 @@ class DatasetApi:
1025
998
 
1026
999
 
1027
1000
  @validate_call
1028
- def datasets_list_datasets_get_without_preload_content(
1001
+ def list_saved_queries_queries_get_without_preload_content(
1029
1002
  self,
1030
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
1031
1003
  _request_timeout: Union[
1032
1004
  None,
1033
1005
  Annotated[StrictFloat, Field(gt=0)],
@@ -1041,12 +1013,10 @@ class DatasetApi:
1041
1013
  _headers: Optional[Dict[StrictStr, Any]] = None,
1042
1014
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1043
1015
  ) -> RESTResponseType:
1044
- """List Datasets
1016
+ """List Saved Queries
1045
1017
 
1046
- List Datasets returns information about all account datasets including schema and provisioning status.
1018
+ List all available saved queries.
1047
1019
 
1048
- :param x_api_key: (required)
1049
- :type x_api_key: str
1050
1020
  :param _request_timeout: timeout setting for this request. If one
1051
1021
  number provided, it will be total request
1052
1022
  timeout. It can also be a pair (tuple) of
@@ -1069,8 +1039,7 @@ class DatasetApi:
1069
1039
  :return: Returns the result object.
1070
1040
  """ # noqa: E501
1071
1041
 
1072
- _param = self._datasets_list_datasets_get_serialize(
1073
- x_api_key=x_api_key,
1042
+ _param = self._list_saved_queries_queries_get_serialize(
1074
1043
  _request_auth=_request_auth,
1075
1044
  _content_type=_content_type,
1076
1045
  _headers=_headers,
@@ -1078,8 +1047,7 @@ class DatasetApi:
1078
1047
  )
1079
1048
 
1080
1049
  _response_types_map: Dict[str, Optional[str]] = {
1081
- '200': "ListDatasetsResponse",
1082
- '422': "HTTPValidationError",
1050
+ '200': "SavedQueryListResponse",
1083
1051
  }
1084
1052
  response_data = self.api_client.call_api(
1085
1053
  *_param,
@@ -1088,9 +1056,8 @@ class DatasetApi:
1088
1056
  return response_data.response
1089
1057
 
1090
1058
 
1091
- def _datasets_list_datasets_get_serialize(
1059
+ def _list_saved_queries_queries_get_serialize(
1092
1060
  self,
1093
- x_api_key,
1094
1061
  _request_auth,
1095
1062
  _content_type,
1096
1063
  _headers,
@@ -1114,8 +1081,6 @@ class DatasetApi:
1114
1081
  # process the path parameters
1115
1082
  # process the query parameters
1116
1083
  # process the header parameters
1117
- if x_api_key is not None:
1118
- _header_params['x-api-key'] = x_api_key
1119
1084
  # process the form parameters
1120
1085
  # process the body parameter
1121
1086
 
@@ -1135,7 +1100,7 @@ class DatasetApi:
1135
1100
 
1136
1101
  return self.api_client.param_serialize(
1137
1102
  method='GET',
1138
- resource_path='/datasets/',
1103
+ resource_path='/queries',
1139
1104
  path_params=_path_params,
1140
1105
  query_params=_query_params,
1141
1106
  header_params=_header_params,