shaped 2.0.0__py3-none-any.whl → 2.0.2__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 (323) hide show
  1. shaped/__init__.py +54 -4
  2. shaped/autogen/__init__.py +541 -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} +219 -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 +15 -8
  9. shaped/autogen/configuration.py +20 -9
  10. shaped/autogen/exceptions.py +19 -2
  11. shaped/autogen/models/__init__.py +254 -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 +136 -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 +126 -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 +123 -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 +134 -0
  65. shaped/autogen/models/entity_config.py +109 -0
  66. shaped/autogen/models/entity_journey.py +152 -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 +140 -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/global_filter.py +102 -0
  81. shaped/autogen/models/hidden_dropout_prob.py +136 -0
  82. shaped/autogen/models/hidden_size.py +136 -0
  83. shaped/autogen/models/hidden_size1.py +136 -0
  84. shaped/autogen/models/http_problem_response.py +115 -0
  85. shaped/autogen/models/http_validation_error.py +2 -2
  86. shaped/autogen/models/hugging_face_encoder.py +113 -0
  87. shaped/autogen/models/iceberg_table_config.py +154 -0
  88. shaped/autogen/models/index_config.py +101 -0
  89. shaped/autogen/models/inner_size.py +136 -0
  90. shaped/autogen/models/inner_size1.py +136 -0
  91. shaped/autogen/models/interaction_config.py +122 -0
  92. shaped/autogen/models/interaction_pooling_encoder.py +104 -0
  93. shaped/autogen/models/interaction_round_robin_encoder.py +104 -0
  94. shaped/autogen/models/item_attribute_pooling_encoder.py +124 -0
  95. shaped/autogen/models/journey.py +140 -0
  96. shaped/autogen/models/kafka_table_config.py +129 -0
  97. shaped/autogen/models/kinesis_table_config.py +140 -0
  98. shaped/autogen/models/kinesis_table_config_column_schema_value.py +136 -0
  99. shaped/autogen/models/label.py +90 -0
  100. shaped/autogen/models/label_type.py +37 -0
  101. shaped/autogen/models/laplace_smoothing.py +136 -0
  102. shaped/autogen/models/latency_scaling_policy.py +112 -0
  103. shaped/autogen/models/learning_rate.py +136 -0
  104. shaped/autogen/models/learning_rate1.py +136 -0
  105. shaped/autogen/models/learning_rate2.py +136 -0
  106. shaped/autogen/models/learning_rate3.py +136 -0
  107. shaped/autogen/models/lexical_search_mode.py +99 -0
  108. shaped/autogen/models/list_engines_response.py +95 -0
  109. shaped/autogen/models/list_tables_response.py +95 -0
  110. shaped/autogen/models/list_views_response.py +95 -0
  111. shaped/autogen/models/loss_types.py +37 -0
  112. shaped/autogen/models/lr.py +136 -0
  113. shaped/autogen/models/lr1.py +136 -0
  114. shaped/autogen/models/lr2.py +136 -0
  115. shaped/autogen/models/max_depth.py +136 -0
  116. shaped/autogen/models/max_leaves.py +136 -0
  117. shaped/autogen/models/max_seq_length.py +136 -0
  118. shaped/autogen/models/max_seq_length1.py +136 -0
  119. shaped/autogen/models/max_seq_length2.py +136 -0
  120. shaped/autogen/models/mode.py +134 -0
  121. shaped/autogen/models/mode1.py +134 -0
  122. shaped/autogen/models/mode2.py +136 -0
  123. shaped/autogen/models/mongo_db_table_config.py +147 -0
  124. shaped/autogen/models/mssql_table_config.py +155 -0
  125. shaped/autogen/models/{my_sql_dataset_config.py → my_sql_table_config.py} +45 -28
  126. shaped/autogen/models/n_epochs.py +136 -0
  127. shaped/autogen/models/n_epochs1.py +136 -0
  128. shaped/autogen/models/n_epochs2.py +136 -0
  129. shaped/autogen/models/n_estimators.py +136 -0
  130. shaped/autogen/models/n_heads.py +136 -0
  131. shaped/autogen/models/n_layers.py +136 -0
  132. shaped/autogen/models/neg_per_positive.py +136 -0
  133. shaped/autogen/models/negative_samples_count.py +136 -0
  134. shaped/autogen/models/ngram_tokenizer.py +103 -0
  135. shaped/autogen/models/no_op_config.py +117 -0
  136. shaped/autogen/models/num_blocks.py +136 -0
  137. shaped/autogen/models/num_heads.py +136 -0
  138. shaped/autogen/models/num_leaves.py +136 -0
  139. shaped/autogen/models/objective.py +40 -0
  140. shaped/autogen/models/objective1.py +134 -0
  141. shaped/autogen/models/online_store_config.py +89 -0
  142. shaped/autogen/models/pagination_config.py +87 -0
  143. shaped/autogen/models/parameter_definition.py +96 -0
  144. shaped/autogen/models/parameters_value.py +240 -0
  145. shaped/autogen/models/passthrough_score.py +104 -0
  146. shaped/autogen/models/personal_filter.py +104 -0
  147. shaped/autogen/models/pipeline_stage_explanation.py +118 -0
  148. shaped/autogen/models/policy.py +134 -0
  149. shaped/autogen/models/pool_fn.py +134 -0
  150. shaped/autogen/models/pooling_function.py +37 -0
  151. shaped/autogen/models/{postgres_dataset_config.py → postgres_table_config.py} +66 -28
  152. shaped/autogen/models/posthog_table_config.py +133 -0
  153. shaped/autogen/models/prebuilt_filter_step.py +113 -0
  154. shaped/autogen/models/precomputed_item_embedding.py +99 -0
  155. shaped/autogen/models/precomputed_user_embedding.py +99 -0
  156. shaped/autogen/models/query.py +136 -0
  157. shaped/autogen/models/query1.py +136 -0
  158. shaped/autogen/models/query_any_of.py +140 -0
  159. shaped/autogen/models/query_definition.py +106 -0
  160. shaped/autogen/models/query_encoder.py +194 -0
  161. shaped/autogen/models/query_explanation.py +197 -0
  162. shaped/autogen/models/query_request.py +121 -0
  163. shaped/autogen/models/query_result.py +113 -0
  164. shaped/autogen/models/query_table_config.py +99 -0
  165. shaped/autogen/models/rank_item_attribute_values_query_config.py +122 -0
  166. shaped/autogen/models/rank_query_config.py +167 -0
  167. shaped/autogen/models/rank_query_config_filter_inner.py +149 -0
  168. shaped/autogen/models/rank_query_config_reorder_inner.py +149 -0
  169. shaped/autogen/models/rank_query_config_retrieve_inner.py +196 -0
  170. shaped/autogen/models/recreate_rollout.py +97 -0
  171. shaped/autogen/models/{redshift_dataset_config.py → redshift_table_config.py} +48 -25
  172. shaped/autogen/models/reference_table_config.py +113 -0
  173. shaped/autogen/models/regularization.py +136 -0
  174. shaped/autogen/models/request.py +378 -0
  175. shaped/autogen/models/request1.py +140 -0
  176. shaped/autogen/models/requests_per_second_scaling_policy.py +112 -0
  177. shaped/autogen/models/response_get_view_details_views_view_name_get.py +134 -0
  178. shaped/autogen/models/result.py +145 -0
  179. shaped/autogen/models/result_embeddings_value.py +127 -0
  180. shaped/autogen/models/retriever.py +196 -0
  181. shaped/autogen/models/retriever1.py +196 -0
  182. shaped/autogen/models/rollout_config.py +91 -0
  183. shaped/autogen/models/rudderstack_table_config.py +106 -0
  184. shaped/autogen/models/sampling_strategy.py +36 -0
  185. shaped/autogen/models/saved_query_info_response.py +89 -0
  186. shaped/autogen/models/saved_query_list_response.py +87 -0
  187. shaped/autogen/models/saved_query_request.py +115 -0
  188. shaped/autogen/models/schema_config.py +117 -0
  189. shaped/autogen/models/score.py +134 -0
  190. shaped/autogen/models/score_ensemble.py +140 -0
  191. shaped/autogen/models/score_ensemble_policy_config.py +141 -0
  192. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +422 -0
  193. shaped/autogen/models/search_config.py +105 -0
  194. shaped/autogen/models/segment_table_config.py +106 -0
  195. shaped/autogen/models/sequence_length.py +136 -0
  196. shaped/autogen/models/server_config.py +87 -0
  197. shaped/autogen/models/setup_engine_response.py +87 -0
  198. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +148 -0
  199. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +154 -0
  200. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +209 -0
  201. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +137 -0
  202. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +139 -0
  203. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +205 -0
  204. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +140 -0
  205. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +152 -0
  206. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +239 -0
  207. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +119 -0
  208. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +137 -0
  209. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +104 -0
  210. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +130 -0
  211. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +123 -0
  212. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +224 -0
  213. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +119 -0
  214. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +159 -0
  215. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +131 -0
  216. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +131 -0
  217. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +149 -0
  218. shaped/autogen/models/shopify_table_config.py +156 -0
  219. shaped/autogen/models/similarity_retrieve_step.py +121 -0
  220. shaped/autogen/models/{snowflake_dataset_config.py → snowflake_table_config.py} +47 -18
  221. shaped/autogen/models/sql_transform_type.py +37 -0
  222. shaped/autogen/models/sql_view_config.py +111 -0
  223. shaped/autogen/models/stemmer_tokenizer.py +105 -0
  224. shaped/autogen/models/step_explanation.py +137 -0
  225. shaped/autogen/models/strategy.py +134 -0
  226. shaped/autogen/models/table.py +102 -0
  227. shaped/autogen/models/table_deployment_type.py +38 -0
  228. shaped/autogen/models/table_insert_arguments.py +87 -0
  229. shaped/autogen/models/table_insert_response.py +87 -0
  230. shaped/autogen/models/text_encoding.py +136 -0
  231. shaped/autogen/models/text_search_retrieve_step.py +121 -0
  232. shaped/autogen/models/time_frequency.py +136 -0
  233. shaped/autogen/models/time_window.py +136 -0
  234. shaped/autogen/models/time_window_in_days.py +142 -0
  235. shaped/autogen/models/tokenizer.py +149 -0
  236. shaped/autogen/models/trained_model_encoder.py +99 -0
  237. shaped/autogen/models/training_compute_config.py +99 -0
  238. shaped/autogen/models/training_config.py +121 -0
  239. shaped/autogen/models/training_config_models_inner.py +308 -0
  240. shaped/autogen/models/training_strategy.py +37 -0
  241. shaped/autogen/models/trending_mode.py +37 -0
  242. shaped/autogen/models/truncate_filter_step.py +106 -0
  243. shaped/autogen/models/tunable_bool.py +97 -0
  244. shaped/autogen/models/tunable_float.py +118 -0
  245. shaped/autogen/models/tunable_int.py +118 -0
  246. shaped/autogen/models/tunable_int_categorical.py +99 -0
  247. shaped/autogen/models/tunable_string.py +99 -0
  248. shaped/autogen/models/tuning_config.py +89 -0
  249. shaped/autogen/models/type.py +134 -0
  250. shaped/autogen/models/update_table_response.py +87 -0
  251. shaped/autogen/models/update_view_response.py +87 -0
  252. shaped/autogen/models/user_attribute_pooling_encoder.py +124 -0
  253. shaped/autogen/models/val_split.py +136 -0
  254. shaped/autogen/models/validation_error.py +13 -3
  255. shaped/autogen/models/validation_error_loc_inner.py +138 -0
  256. shaped/autogen/models/value_type.py +7 -5
  257. shaped/autogen/models/vector_search_mode.py +99 -0
  258. shaped/autogen/models/view.py +104 -0
  259. shaped/autogen/models/view_details_ai.py +140 -0
  260. shaped/autogen/models/view_details_ai_schema_value.py +153 -0
  261. shaped/autogen/models/view_details_sql.py +140 -0
  262. shaped/autogen/models/view_status.py +41 -0
  263. shaped/autogen/models/weight_decay.py +136 -0
  264. shaped/autogen/models/whitespace_tokenizer.py +97 -0
  265. shaped/autogen/models/window_size.py +136 -0
  266. shaped/autogen/rest.py +8 -2
  267. shaped/cli/shaped_cli.py +12 -7
  268. shaped/client.py +587 -174
  269. shaped/config_builders.py +695 -0
  270. shaped/query_builder.py +774 -0
  271. {shaped-2.0.0.dist-info → shaped-2.0.2.dist-info}/METADATA +119 -56
  272. shaped-2.0.2.dist-info/RECORD +278 -0
  273. shaped-2.0.2.dist-info/entry_points.txt +2 -0
  274. shaped/autogen/api/model_inference_api.py +0 -2825
  275. shaped/autogen/models/amplitude_dataset_config.py +0 -96
  276. shaped/autogen/models/aws_pinpoint_dataset_config.py +0 -96
  277. shaped/autogen/models/big_query_dataset_config.py +0 -114
  278. shaped/autogen/models/complement_items_request.py +0 -99
  279. shaped/autogen/models/complement_items_response.py +0 -89
  280. shaped/autogen/models/connectors_inner.py +0 -134
  281. shaped/autogen/models/create_dataset_arguments.py +0 -263
  282. shaped/autogen/models/create_embedding_response.py +0 -87
  283. shaped/autogen/models/create_item_embedding_request.py +0 -89
  284. shaped/autogen/models/create_model_arguments.py +0 -107
  285. shaped/autogen/models/create_model_response.py +0 -87
  286. shaped/autogen/models/create_user_embedding_request.py +0 -89
  287. shaped/autogen/models/custom_dataset_config.py +0 -115
  288. shaped/autogen/models/dataset_config.py +0 -101
  289. shaped/autogen/models/dataset_schema_type.py +0 -47
  290. shaped/autogen/models/datasets_inner.py +0 -91
  291. shaped/autogen/models/delete_model_response.py +0 -87
  292. shaped/autogen/models/fetch_config.py +0 -95
  293. shaped/autogen/models/file_config.py +0 -105
  294. shaped/autogen/models/file_source_config.py +0 -89
  295. shaped/autogen/models/inference_config.py +0 -101
  296. shaped/autogen/models/insert_model_response.py +0 -87
  297. shaped/autogen/models/interaction.py +0 -87
  298. shaped/autogen/models/list_datasets_response.py +0 -95
  299. shaped/autogen/models/list_models_response.py +0 -95
  300. shaped/autogen/models/model_config.py +0 -99
  301. shaped/autogen/models/model_response.py +0 -95
  302. shaped/autogen/models/mongo_db_dataset_config.py +0 -119
  303. shaped/autogen/models/post_rank_request.py +0 -117
  304. shaped/autogen/models/rank_attribute_response.py +0 -89
  305. shaped/autogen/models/rank_grid_attribute_request.py +0 -91
  306. shaped/autogen/models/rank_grid_attribute_request1.py +0 -93
  307. shaped/autogen/models/rank_grid_attribute_response.py +0 -91
  308. shaped/autogen/models/rank_response.py +0 -91
  309. shaped/autogen/models/retrieve_request.py +0 -101
  310. shaped/autogen/models/retrieve_response.py +0 -91
  311. shaped/autogen/models/retriever_top_k_override.py +0 -97
  312. shaped/autogen/models/rudder_stack_dataset_config.py +0 -96
  313. shaped/autogen/models/segment_dataset_config.py +0 -96
  314. shaped/autogen/models/similar_item_request.py +0 -101
  315. shaped/autogen/models/similar_response.py +0 -89
  316. shaped/autogen/models/similar_users_request.py +0 -99
  317. shaped/autogen/models/successful_response.py +0 -87
  318. shaped/autogen/models/view_model_response.py +0 -99
  319. shaped-2.0.0.dist-info/RECORD +0 -73
  320. shaped-2.0.0.dist-info/entry_points.txt +0 -2
  321. {shaped-2.0.0.dist-info → shaped-2.0.2.dist-info}/WHEEL +0 -0
  322. {shaped-2.0.0.dist-info → shaped-2.0.2.dist-info}/top_level.txt +0 -0
  323. {shaped-2.0.0.dist-info → shaped-2.0.2.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.0
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -18,18 +18,19 @@ from typing_extensions import Annotated
18
18
 
19
19
  from pydantic import Field, StrictStr
20
20
  from typing_extensions import Annotated
21
- from shaped.autogen.models.create_model_arguments import CreateModelArguments
22
- from shaped.autogen.models.create_model_response import CreateModelResponse
23
- from shaped.autogen.models.delete_model_response import DeleteModelResponse
24
- from shaped.autogen.models.list_models_response import ListModelsResponse
25
- from shaped.autogen.models.view_model_response import ViewModelResponse
21
+ from shaped.autogen.models.create_view_response import CreateViewResponse
22
+ from shaped.autogen.models.delete_view_response import DeleteViewResponse
23
+ from shaped.autogen.models.list_views_response import ListViewsResponse
24
+ from shaped.autogen.models.request1 import Request1
25
+ from shaped.autogen.models.response_get_view_details_views_view_name_get import ResponseGetViewDetailsViewsViewNameGet
26
+ from shaped.autogen.models.update_view_response import UpdateViewResponse
26
27
 
27
28
  from shaped.autogen.api_client import ApiClient, RequestSerialized
28
29
  from shaped.autogen.api_response import ApiResponse
29
30
  from shaped.autogen.rest import RESTResponseType
30
31
 
31
32
 
32
- class ModelManagementApi:
33
+ class ViewApi:
33
34
  """NOTE: This class is auto generated by OpenAPI Generator
34
35
  Ref: https://openapi-generator.tech
35
36
 
@@ -43,10 +44,10 @@ class ModelManagementApi:
43
44
 
44
45
 
45
46
  @validate_call
46
- def get_models_model_name_delete_model(
47
+ def delete_view_views_view_name_delete(
47
48
  self,
48
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
49
- model_name: StrictStr,
49
+ view_name: Annotated[StrictStr, Field(description="Name of the view to delete.")],
50
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
50
51
  _request_timeout: Union[
51
52
  None,
52
53
  Annotated[StrictFloat, Field(gt=0)],
@@ -59,15 +60,14 @@ class ModelManagementApi:
59
60
  _content_type: Optional[StrictStr] = None,
60
61
  _headers: Optional[Dict[StrictStr, Any]] = None,
61
62
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
62
- ) -> DeleteModelResponse:
63
- """Delete Model
63
+ ) -> DeleteViewResponse:
64
+ """Delete View
64
65
 
65
- Delete the model with identifier: {model_name}.
66
66
 
67
- :param x_api_key: (required)
67
+ :param view_name: Name of the view to delete. (required)
68
+ :type view_name: str
69
+ :param x_api_key: API key for authentication. (required)
68
70
  :type x_api_key: str
69
- :param model_name: (required)
70
- :type model_name: str
71
71
  :param _request_timeout: timeout setting for this request. If one
72
72
  number provided, it will be total request
73
73
  timeout. It can also be a pair (tuple) of
@@ -90,9 +90,9 @@ class ModelManagementApi:
90
90
  :return: Returns the result object.
91
91
  """ # noqa: E501
92
92
 
93
- _param = self._get_models_model_name_delete_model_serialize(
93
+ _param = self._delete_view_views_view_name_delete_serialize(
94
+ view_name=view_name,
94
95
  x_api_key=x_api_key,
95
- model_name=model_name,
96
96
  _request_auth=_request_auth,
97
97
  _content_type=_content_type,
98
98
  _headers=_headers,
@@ -100,7 +100,7 @@ class ModelManagementApi:
100
100
  )
101
101
 
102
102
  _response_types_map: Dict[str, Optional[str]] = {
103
- '200': "DeleteModelResponse",
103
+ '200': "DeleteViewResponse",
104
104
  '422': "HTTPValidationError",
105
105
  }
106
106
  response_data = self.api_client.call_api(
@@ -115,10 +115,10 @@ class ModelManagementApi:
115
115
 
116
116
 
117
117
  @validate_call
118
- def get_models_model_name_delete_model_with_http_info(
118
+ def delete_view_views_view_name_delete_with_http_info(
119
119
  self,
120
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
121
- model_name: StrictStr,
120
+ view_name: Annotated[StrictStr, Field(description="Name of the view to delete.")],
121
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
122
122
  _request_timeout: Union[
123
123
  None,
124
124
  Annotated[StrictFloat, Field(gt=0)],
@@ -131,15 +131,14 @@ class ModelManagementApi:
131
131
  _content_type: Optional[StrictStr] = None,
132
132
  _headers: Optional[Dict[StrictStr, Any]] = None,
133
133
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
134
- ) -> ApiResponse[DeleteModelResponse]:
135
- """Delete Model
134
+ ) -> ApiResponse[DeleteViewResponse]:
135
+ """Delete View
136
136
 
137
- Delete the model with identifier: {model_name}.
138
137
 
139
- :param x_api_key: (required)
138
+ :param view_name: Name of the view to delete. (required)
139
+ :type view_name: str
140
+ :param x_api_key: API key for authentication. (required)
140
141
  :type x_api_key: str
141
- :param model_name: (required)
142
- :type model_name: str
143
142
  :param _request_timeout: timeout setting for this request. If one
144
143
  number provided, it will be total request
145
144
  timeout. It can also be a pair (tuple) of
@@ -162,9 +161,9 @@ class ModelManagementApi:
162
161
  :return: Returns the result object.
163
162
  """ # noqa: E501
164
163
 
165
- _param = self._get_models_model_name_delete_model_serialize(
164
+ _param = self._delete_view_views_view_name_delete_serialize(
165
+ view_name=view_name,
166
166
  x_api_key=x_api_key,
167
- model_name=model_name,
168
167
  _request_auth=_request_auth,
169
168
  _content_type=_content_type,
170
169
  _headers=_headers,
@@ -172,7 +171,7 @@ class ModelManagementApi:
172
171
  )
173
172
 
174
173
  _response_types_map: Dict[str, Optional[str]] = {
175
- '200': "DeleteModelResponse",
174
+ '200': "DeleteViewResponse",
176
175
  '422': "HTTPValidationError",
177
176
  }
178
177
  response_data = self.api_client.call_api(
@@ -187,10 +186,10 @@ class ModelManagementApi:
187
186
 
188
187
 
189
188
  @validate_call
190
- def get_models_model_name_delete_model_without_preload_content(
189
+ def delete_view_views_view_name_delete_without_preload_content(
191
190
  self,
192
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
193
- model_name: StrictStr,
191
+ view_name: Annotated[StrictStr, Field(description="Name of the view to delete.")],
192
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
194
193
  _request_timeout: Union[
195
194
  None,
196
195
  Annotated[StrictFloat, Field(gt=0)],
@@ -204,14 +203,13 @@ class ModelManagementApi:
204
203
  _headers: Optional[Dict[StrictStr, Any]] = None,
205
204
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
206
205
  ) -> RESTResponseType:
207
- """Delete Model
206
+ """Delete View
208
207
 
209
- Delete the model with identifier: {model_name}.
210
208
 
211
- :param x_api_key: (required)
209
+ :param view_name: Name of the view to delete. (required)
210
+ :type view_name: str
211
+ :param x_api_key: API key for authentication. (required)
212
212
  :type x_api_key: str
213
- :param model_name: (required)
214
- :type model_name: str
215
213
  :param _request_timeout: timeout setting for this request. If one
216
214
  number provided, it will be total request
217
215
  timeout. It can also be a pair (tuple) of
@@ -234,9 +232,9 @@ class ModelManagementApi:
234
232
  :return: Returns the result object.
235
233
  """ # noqa: E501
236
234
 
237
- _param = self._get_models_model_name_delete_model_serialize(
235
+ _param = self._delete_view_views_view_name_delete_serialize(
236
+ view_name=view_name,
238
237
  x_api_key=x_api_key,
239
- model_name=model_name,
240
238
  _request_auth=_request_auth,
241
239
  _content_type=_content_type,
242
240
  _headers=_headers,
@@ -244,7 +242,7 @@ class ModelManagementApi:
244
242
  )
245
243
 
246
244
  _response_types_map: Dict[str, Optional[str]] = {
247
- '200': "DeleteModelResponse",
245
+ '200': "DeleteViewResponse",
248
246
  '422': "HTTPValidationError",
249
247
  }
250
248
  response_data = self.api_client.call_api(
@@ -254,10 +252,10 @@ class ModelManagementApi:
254
252
  return response_data.response
255
253
 
256
254
 
257
- def _get_models_model_name_delete_model_serialize(
255
+ def _delete_view_views_view_name_delete_serialize(
258
256
  self,
257
+ view_name,
259
258
  x_api_key,
260
- model_name,
261
259
  _request_auth,
262
260
  _content_type,
263
261
  _headers,
@@ -279,8 +277,8 @@ class ModelManagementApi:
279
277
  _body_params: Optional[bytes] = None
280
278
 
281
279
  # process the path parameters
282
- if model_name is not None:
283
- _path_params['model_name'] = model_name
280
+ if view_name is not None:
281
+ _path_params['view_name'] = view_name
284
282
  # process the query parameters
285
283
  # process the header parameters
286
284
  if x_api_key is not None:
@@ -304,7 +302,7 @@ class ModelManagementApi:
304
302
 
305
303
  return self.api_client.param_serialize(
306
304
  method='DELETE',
307
- resource_path='/models/{model_name}',
305
+ resource_path='/views/{view_name}',
308
306
  path_params=_path_params,
309
307
  query_params=_query_params,
310
308
  header_params=_header_params,
@@ -321,10 +319,10 @@ class ModelManagementApi:
321
319
 
322
320
 
323
321
  @validate_call
324
- def get_models_model_name_models_get(
322
+ def get_view_details_views_view_name_get(
325
323
  self,
326
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
327
- model_name: StrictStr,
324
+ view_name: Annotated[StrictStr, Field(description="Name of the view to retrieve.")],
325
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
328
326
  _request_timeout: Union[
329
327
  None,
330
328
  Annotated[StrictFloat, Field(gt=0)],
@@ -337,15 +335,15 @@ class ModelManagementApi:
337
335
  _content_type: Optional[StrictStr] = None,
338
336
  _headers: Optional[Dict[StrictStr, Any]] = None,
339
337
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
340
- ) -> ViewModelResponse:
341
- """View Model
338
+ ) -> ResponseGetViewDetailsViewsViewNameGet:
339
+ """Get View Details
342
340
 
343
- View Models returns detailed information about the given {model_name} including the input setup schemas details and status.
341
+ Get detailed information about a specific view.
344
342
 
345
- :param x_api_key: (required)
343
+ :param view_name: Name of the view to retrieve. (required)
344
+ :type view_name: str
345
+ :param x_api_key: API key for authentication. (required)
346
346
  :type x_api_key: str
347
- :param model_name: (required)
348
- :type model_name: str
349
347
  :param _request_timeout: timeout setting for this request. If one
350
348
  number provided, it will be total request
351
349
  timeout. It can also be a pair (tuple) of
@@ -368,9 +366,9 @@ class ModelManagementApi:
368
366
  :return: Returns the result object.
369
367
  """ # noqa: E501
370
368
 
371
- _param = self._get_models_model_name_models_get_serialize(
369
+ _param = self._get_view_details_views_view_name_get_serialize(
370
+ view_name=view_name,
372
371
  x_api_key=x_api_key,
373
- model_name=model_name,
374
372
  _request_auth=_request_auth,
375
373
  _content_type=_content_type,
376
374
  _headers=_headers,
@@ -378,7 +376,8 @@ class ModelManagementApi:
378
376
  )
379
377
 
380
378
  _response_types_map: Dict[str, Optional[str]] = {
381
- '200': "ViewModelResponse",
379
+ '200': "ResponseGetViewDetailsViewsViewNameGet",
380
+ '404': "HttpProblemResponse",
382
381
  '422': "HTTPValidationError",
383
382
  }
384
383
  response_data = self.api_client.call_api(
@@ -393,10 +392,10 @@ class ModelManagementApi:
393
392
 
394
393
 
395
394
  @validate_call
396
- def get_models_model_name_models_get_with_http_info(
395
+ def get_view_details_views_view_name_get_with_http_info(
397
396
  self,
398
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
399
- model_name: StrictStr,
397
+ view_name: Annotated[StrictStr, Field(description="Name of the view to retrieve.")],
398
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
400
399
  _request_timeout: Union[
401
400
  None,
402
401
  Annotated[StrictFloat, Field(gt=0)],
@@ -409,15 +408,15 @@ class ModelManagementApi:
409
408
  _content_type: Optional[StrictStr] = None,
410
409
  _headers: Optional[Dict[StrictStr, Any]] = None,
411
410
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
412
- ) -> ApiResponse[ViewModelResponse]:
413
- """View Model
411
+ ) -> ApiResponse[ResponseGetViewDetailsViewsViewNameGet]:
412
+ """Get View Details
414
413
 
415
- View Models returns detailed information about the given {model_name} including the input setup schemas details and status.
414
+ Get detailed information about a specific view.
416
415
 
417
- :param x_api_key: (required)
416
+ :param view_name: Name of the view to retrieve. (required)
417
+ :type view_name: str
418
+ :param x_api_key: API key for authentication. (required)
418
419
  :type x_api_key: str
419
- :param model_name: (required)
420
- :type model_name: str
421
420
  :param _request_timeout: timeout setting for this request. If one
422
421
  number provided, it will be total request
423
422
  timeout. It can also be a pair (tuple) of
@@ -440,9 +439,9 @@ class ModelManagementApi:
440
439
  :return: Returns the result object.
441
440
  """ # noqa: E501
442
441
 
443
- _param = self._get_models_model_name_models_get_serialize(
442
+ _param = self._get_view_details_views_view_name_get_serialize(
443
+ view_name=view_name,
444
444
  x_api_key=x_api_key,
445
- model_name=model_name,
446
445
  _request_auth=_request_auth,
447
446
  _content_type=_content_type,
448
447
  _headers=_headers,
@@ -450,7 +449,8 @@ class ModelManagementApi:
450
449
  )
451
450
 
452
451
  _response_types_map: Dict[str, Optional[str]] = {
453
- '200': "ViewModelResponse",
452
+ '200': "ResponseGetViewDetailsViewsViewNameGet",
453
+ '404': "HttpProblemResponse",
454
454
  '422': "HTTPValidationError",
455
455
  }
456
456
  response_data = self.api_client.call_api(
@@ -465,10 +465,10 @@ class ModelManagementApi:
465
465
 
466
466
 
467
467
  @validate_call
468
- def get_models_model_name_models_get_without_preload_content(
468
+ def get_view_details_views_view_name_get_without_preload_content(
469
469
  self,
470
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
471
- model_name: StrictStr,
470
+ view_name: Annotated[StrictStr, Field(description="Name of the view to retrieve.")],
471
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
472
472
  _request_timeout: Union[
473
473
  None,
474
474
  Annotated[StrictFloat, Field(gt=0)],
@@ -482,14 +482,14 @@ class ModelManagementApi:
482
482
  _headers: Optional[Dict[StrictStr, Any]] = None,
483
483
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
484
484
  ) -> RESTResponseType:
485
- """View Model
485
+ """Get View Details
486
486
 
487
- View Models returns detailed information about the given {model_name} including the input setup schemas details and status.
487
+ Get detailed information about a specific view.
488
488
 
489
- :param x_api_key: (required)
489
+ :param view_name: Name of the view to retrieve. (required)
490
+ :type view_name: str
491
+ :param x_api_key: API key for authentication. (required)
490
492
  :type x_api_key: str
491
- :param model_name: (required)
492
- :type model_name: str
493
493
  :param _request_timeout: timeout setting for this request. If one
494
494
  number provided, it will be total request
495
495
  timeout. It can also be a pair (tuple) of
@@ -512,9 +512,9 @@ class ModelManagementApi:
512
512
  :return: Returns the result object.
513
513
  """ # noqa: E501
514
514
 
515
- _param = self._get_models_model_name_models_get_serialize(
515
+ _param = self._get_view_details_views_view_name_get_serialize(
516
+ view_name=view_name,
516
517
  x_api_key=x_api_key,
517
- model_name=model_name,
518
518
  _request_auth=_request_auth,
519
519
  _content_type=_content_type,
520
520
  _headers=_headers,
@@ -522,7 +522,8 @@ class ModelManagementApi:
522
522
  )
523
523
 
524
524
  _response_types_map: Dict[str, Optional[str]] = {
525
- '200': "ViewModelResponse",
525
+ '200': "ResponseGetViewDetailsViewsViewNameGet",
526
+ '404': "HttpProblemResponse",
526
527
  '422': "HTTPValidationError",
527
528
  }
528
529
  response_data = self.api_client.call_api(
@@ -532,10 +533,10 @@ class ModelManagementApi:
532
533
  return response_data.response
533
534
 
534
535
 
535
- def _get_models_model_name_models_get_serialize(
536
+ def _get_view_details_views_view_name_get_serialize(
536
537
  self,
538
+ view_name,
537
539
  x_api_key,
538
- model_name,
539
540
  _request_auth,
540
541
  _content_type,
541
542
  _headers,
@@ -557,8 +558,8 @@ class ModelManagementApi:
557
558
  _body_params: Optional[bytes] = None
558
559
 
559
560
  # process the path parameters
560
- if model_name is not None:
561
- _path_params['model_name'] = model_name
561
+ if view_name is not None:
562
+ _path_params['view_name'] = view_name
562
563
  # process the query parameters
563
564
  # process the header parameters
564
565
  if x_api_key is not None:
@@ -582,7 +583,7 @@ class ModelManagementApi:
582
583
 
583
584
  return self.api_client.param_serialize(
584
585
  method='GET',
585
- resource_path='/models/{model_name}',
586
+ resource_path='/views/{view_name}',
586
587
  path_params=_path_params,
587
588
  query_params=_query_params,
588
589
  header_params=_header_params,
@@ -599,9 +600,9 @@ class ModelManagementApi:
599
600
 
600
601
 
601
602
  @validate_call
602
- def get_models_models_get(
603
+ def get_views_views_get(
603
604
  self,
604
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
605
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
605
606
  _request_timeout: Union[
606
607
  None,
607
608
  Annotated[StrictFloat, Field(gt=0)],
@@ -614,12 +615,12 @@ class ModelManagementApi:
614
615
  _content_type: Optional[StrictStr] = None,
615
616
  _headers: Optional[Dict[StrictStr, Any]] = None,
616
617
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
617
- ) -> ListModelsResponse:
618
- """List Models
618
+ ) -> ListViewsResponse:
619
+ """List Views
619
620
 
620
- List Models returns a list of your previously created models and their associated metadata (e.g. status and last train time).
621
+ List all views for the authenticated tenant.
621
622
 
622
- :param x_api_key: (required)
623
+ :param x_api_key: API key for authentication. (required)
623
624
  :type x_api_key: str
624
625
  :param _request_timeout: timeout setting for this request. If one
625
626
  number provided, it will be total request
@@ -643,7 +644,7 @@ class ModelManagementApi:
643
644
  :return: Returns the result object.
644
645
  """ # noqa: E501
645
646
 
646
- _param = self._get_models_models_get_serialize(
647
+ _param = self._get_views_views_get_serialize(
647
648
  x_api_key=x_api_key,
648
649
  _request_auth=_request_auth,
649
650
  _content_type=_content_type,
@@ -652,7 +653,7 @@ class ModelManagementApi:
652
653
  )
653
654
 
654
655
  _response_types_map: Dict[str, Optional[str]] = {
655
- '200': "ListModelsResponse",
656
+ '200': "ListViewsResponse",
656
657
  '422': "HTTPValidationError",
657
658
  }
658
659
  response_data = self.api_client.call_api(
@@ -667,9 +668,9 @@ class ModelManagementApi:
667
668
 
668
669
 
669
670
  @validate_call
670
- def get_models_models_get_with_http_info(
671
+ def get_views_views_get_with_http_info(
671
672
  self,
672
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
673
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
673
674
  _request_timeout: Union[
674
675
  None,
675
676
  Annotated[StrictFloat, Field(gt=0)],
@@ -682,12 +683,12 @@ class ModelManagementApi:
682
683
  _content_type: Optional[StrictStr] = None,
683
684
  _headers: Optional[Dict[StrictStr, Any]] = None,
684
685
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
685
- ) -> ApiResponse[ListModelsResponse]:
686
- """List Models
686
+ ) -> ApiResponse[ListViewsResponse]:
687
+ """List Views
687
688
 
688
- List Models returns a list of your previously created models and their associated metadata (e.g. status and last train time).
689
+ List all views for the authenticated tenant.
689
690
 
690
- :param x_api_key: (required)
691
+ :param x_api_key: API key for authentication. (required)
691
692
  :type x_api_key: str
692
693
  :param _request_timeout: timeout setting for this request. If one
693
694
  number provided, it will be total request
@@ -711,7 +712,7 @@ class ModelManagementApi:
711
712
  :return: Returns the result object.
712
713
  """ # noqa: E501
713
714
 
714
- _param = self._get_models_models_get_serialize(
715
+ _param = self._get_views_views_get_serialize(
715
716
  x_api_key=x_api_key,
716
717
  _request_auth=_request_auth,
717
718
  _content_type=_content_type,
@@ -720,7 +721,7 @@ class ModelManagementApi:
720
721
  )
721
722
 
722
723
  _response_types_map: Dict[str, Optional[str]] = {
723
- '200': "ListModelsResponse",
724
+ '200': "ListViewsResponse",
724
725
  '422': "HTTPValidationError",
725
726
  }
726
727
  response_data = self.api_client.call_api(
@@ -735,9 +736,9 @@ class ModelManagementApi:
735
736
 
736
737
 
737
738
  @validate_call
738
- def get_models_models_get_without_preload_content(
739
+ def get_views_views_get_without_preload_content(
739
740
  self,
740
- x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
741
+ x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40, description="API key for authentication.")],
741
742
  _request_timeout: Union[
742
743
  None,
743
744
  Annotated[StrictFloat, Field(gt=0)],
@@ -751,11 +752,11 @@ class ModelManagementApi:
751
752
  _headers: Optional[Dict[StrictStr, Any]] = None,
752
753
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
753
754
  ) -> RESTResponseType:
754
- """List Models
755
+ """List Views
755
756
 
756
- List Models returns a list of your previously created models and their associated metadata (e.g. status and last train time).
757
+ List all views for the authenticated tenant.
757
758
 
758
- :param x_api_key: (required)
759
+ :param x_api_key: API key for authentication. (required)
759
760
  :type x_api_key: str
760
761
  :param _request_timeout: timeout setting for this request. If one
761
762
  number provided, it will be total request
@@ -779,7 +780,7 @@ class ModelManagementApi:
779
780
  :return: Returns the result object.
780
781
  """ # noqa: E501
781
782
 
782
- _param = self._get_models_models_get_serialize(
783
+ _param = self._get_views_views_get_serialize(
783
784
  x_api_key=x_api_key,
784
785
  _request_auth=_request_auth,
785
786
  _content_type=_content_type,
@@ -788,7 +789,7 @@ class ModelManagementApi:
788
789
  )
789
790
 
790
791
  _response_types_map: Dict[str, Optional[str]] = {
791
- '200': "ListModelsResponse",
792
+ '200': "ListViewsResponse",
792
793
  '422': "HTTPValidationError",
793
794
  }
794
795
  response_data = self.api_client.call_api(
@@ -798,7 +799,7 @@ class ModelManagementApi:
798
799
  return response_data.response
799
800
 
800
801
 
801
- def _get_models_models_get_serialize(
802
+ def _get_views_views_get_serialize(
802
803
  self,
803
804
  x_api_key,
804
805
  _request_auth,
@@ -845,7 +846,7 @@ class ModelManagementApi:
845
846
 
846
847
  return self.api_client.param_serialize(
847
848
  method='GET',
848
- resource_path='/models',
849
+ resource_path='/views',
849
850
  path_params=_path_params,
850
851
  query_params=_query_params,
851
852
  header_params=_header_params,
@@ -862,10 +863,10 @@ class ModelManagementApi:
862
863
 
863
864
 
864
865
  @validate_call
865
- def patch_create_models_patch(
866
+ def patch_update_view_views_patch(
866
867
  self,
867
868
  x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
868
- create_model_arguments: CreateModelArguments,
869
+ request1: Request1,
869
870
  _request_timeout: Union[
870
871
  None,
871
872
  Annotated[StrictFloat, Field(gt=0)],
@@ -878,15 +879,14 @@ class ModelManagementApi:
878
879
  _content_type: Optional[StrictStr] = None,
879
880
  _headers: Optional[Dict[StrictStr, Any]] = None,
880
881
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
881
- ) -> CreateModelResponse:
882
- """Update Model
882
+ ) -> UpdateViewResponse:
883
+ """Update View
883
884
 
884
- Update model is used to update the configurations of a currently hosted model within the ERROR or ACTIVE states.
885
885
 
886
886
  :param x_api_key: (required)
887
887
  :type x_api_key: str
888
- :param create_model_arguments: (required)
889
- :type create_model_arguments: CreateModelArguments
888
+ :param request1: (required)
889
+ :type request1: Request1
890
890
  :param _request_timeout: timeout setting for this request. If one
891
891
  number provided, it will be total request
892
892
  timeout. It can also be a pair (tuple) of
@@ -909,9 +909,9 @@ class ModelManagementApi:
909
909
  :return: Returns the result object.
910
910
  """ # noqa: E501
911
911
 
912
- _param = self._patch_create_models_patch_serialize(
912
+ _param = self._patch_update_view_views_patch_serialize(
913
913
  x_api_key=x_api_key,
914
- create_model_arguments=create_model_arguments,
914
+ request1=request1,
915
915
  _request_auth=_request_auth,
916
916
  _content_type=_content_type,
917
917
  _headers=_headers,
@@ -919,7 +919,8 @@ class ModelManagementApi:
919
919
  )
920
920
 
921
921
  _response_types_map: Dict[str, Optional[str]] = {
922
- '200': "CreateModelResponse",
922
+ '200': "UpdateViewResponse",
923
+ '404': "HttpProblemResponse",
923
924
  '422': "HTTPValidationError",
924
925
  }
925
926
  response_data = self.api_client.call_api(
@@ -934,10 +935,10 @@ class ModelManagementApi:
934
935
 
935
936
 
936
937
  @validate_call
937
- def patch_create_models_patch_with_http_info(
938
+ def patch_update_view_views_patch_with_http_info(
938
939
  self,
939
940
  x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
940
- create_model_arguments: CreateModelArguments,
941
+ request1: Request1,
941
942
  _request_timeout: Union[
942
943
  None,
943
944
  Annotated[StrictFloat, Field(gt=0)],
@@ -950,15 +951,14 @@ class ModelManagementApi:
950
951
  _content_type: Optional[StrictStr] = None,
951
952
  _headers: Optional[Dict[StrictStr, Any]] = None,
952
953
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
953
- ) -> ApiResponse[CreateModelResponse]:
954
- """Update Model
954
+ ) -> ApiResponse[UpdateViewResponse]:
955
+ """Update View
955
956
 
956
- Update model is used to update the configurations of a currently hosted model within the ERROR or ACTIVE states.
957
957
 
958
958
  :param x_api_key: (required)
959
959
  :type x_api_key: str
960
- :param create_model_arguments: (required)
961
- :type create_model_arguments: CreateModelArguments
960
+ :param request1: (required)
961
+ :type request1: Request1
962
962
  :param _request_timeout: timeout setting for this request. If one
963
963
  number provided, it will be total request
964
964
  timeout. It can also be a pair (tuple) of
@@ -981,9 +981,9 @@ class ModelManagementApi:
981
981
  :return: Returns the result object.
982
982
  """ # noqa: E501
983
983
 
984
- _param = self._patch_create_models_patch_serialize(
984
+ _param = self._patch_update_view_views_patch_serialize(
985
985
  x_api_key=x_api_key,
986
- create_model_arguments=create_model_arguments,
986
+ request1=request1,
987
987
  _request_auth=_request_auth,
988
988
  _content_type=_content_type,
989
989
  _headers=_headers,
@@ -991,7 +991,8 @@ class ModelManagementApi:
991
991
  )
992
992
 
993
993
  _response_types_map: Dict[str, Optional[str]] = {
994
- '200': "CreateModelResponse",
994
+ '200': "UpdateViewResponse",
995
+ '404': "HttpProblemResponse",
995
996
  '422': "HTTPValidationError",
996
997
  }
997
998
  response_data = self.api_client.call_api(
@@ -1006,10 +1007,10 @@ class ModelManagementApi:
1006
1007
 
1007
1008
 
1008
1009
  @validate_call
1009
- def patch_create_models_patch_without_preload_content(
1010
+ def patch_update_view_views_patch_without_preload_content(
1010
1011
  self,
1011
1012
  x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
1012
- create_model_arguments: CreateModelArguments,
1013
+ request1: Request1,
1013
1014
  _request_timeout: Union[
1014
1015
  None,
1015
1016
  Annotated[StrictFloat, Field(gt=0)],
@@ -1023,14 +1024,13 @@ class ModelManagementApi:
1023
1024
  _headers: Optional[Dict[StrictStr, Any]] = None,
1024
1025
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1025
1026
  ) -> RESTResponseType:
1026
- """Update Model
1027
+ """Update View
1027
1028
 
1028
- Update model is used to update the configurations of a currently hosted model within the ERROR or ACTIVE states.
1029
1029
 
1030
1030
  :param x_api_key: (required)
1031
1031
  :type x_api_key: str
1032
- :param create_model_arguments: (required)
1033
- :type create_model_arguments: CreateModelArguments
1032
+ :param request1: (required)
1033
+ :type request1: Request1
1034
1034
  :param _request_timeout: timeout setting for this request. If one
1035
1035
  number provided, it will be total request
1036
1036
  timeout. It can also be a pair (tuple) of
@@ -1053,9 +1053,9 @@ class ModelManagementApi:
1053
1053
  :return: Returns the result object.
1054
1054
  """ # noqa: E501
1055
1055
 
1056
- _param = self._patch_create_models_patch_serialize(
1056
+ _param = self._patch_update_view_views_patch_serialize(
1057
1057
  x_api_key=x_api_key,
1058
- create_model_arguments=create_model_arguments,
1058
+ request1=request1,
1059
1059
  _request_auth=_request_auth,
1060
1060
  _content_type=_content_type,
1061
1061
  _headers=_headers,
@@ -1063,7 +1063,8 @@ class ModelManagementApi:
1063
1063
  )
1064
1064
 
1065
1065
  _response_types_map: Dict[str, Optional[str]] = {
1066
- '200': "CreateModelResponse",
1066
+ '200': "UpdateViewResponse",
1067
+ '404': "HttpProblemResponse",
1067
1068
  '422': "HTTPValidationError",
1068
1069
  }
1069
1070
  response_data = self.api_client.call_api(
@@ -1073,10 +1074,10 @@ class ModelManagementApi:
1073
1074
  return response_data.response
1074
1075
 
1075
1076
 
1076
- def _patch_create_models_patch_serialize(
1077
+ def _patch_update_view_views_patch_serialize(
1077
1078
  self,
1078
1079
  x_api_key,
1079
- create_model_arguments,
1080
+ request1,
1080
1081
  _request_auth,
1081
1082
  _content_type,
1082
1083
  _headers,
@@ -1104,8 +1105,8 @@ class ModelManagementApi:
1104
1105
  _header_params['x-api-key'] = x_api_key
1105
1106
  # process the form parameters
1106
1107
  # process the body parameter
1107
- if create_model_arguments is not None:
1108
- _body_params = create_model_arguments
1108
+ if request1 is not None:
1109
+ _body_params = request1
1109
1110
 
1110
1111
 
1111
1112
  # set the HTTP header `Accept`
@@ -1136,7 +1137,7 @@ class ModelManagementApi:
1136
1137
 
1137
1138
  return self.api_client.param_serialize(
1138
1139
  method='PATCH',
1139
- resource_path='/models',
1140
+ resource_path='/views',
1140
1141
  path_params=_path_params,
1141
1142
  query_params=_query_params,
1142
1143
  header_params=_header_params,
@@ -1153,10 +1154,10 @@ class ModelManagementApi:
1153
1154
 
1154
1155
 
1155
1156
  @validate_call
1156
- def post_create_models_post(
1157
+ def post_create_view_views_post(
1157
1158
  self,
1158
1159
  x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
1159
- create_model_arguments: CreateModelArguments,
1160
+ request1: Request1,
1160
1161
  _request_timeout: Union[
1161
1162
  None,
1162
1163
  Annotated[StrictFloat, Field(gt=0)],
@@ -1169,15 +1170,14 @@ class ModelManagementApi:
1169
1170
  _content_type: Optional[StrictStr] = None,
1170
1171
  _headers: Optional[Dict[StrictStr, Any]] = None,
1171
1172
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1172
- ) -> CreateModelResponse:
1173
- """Create Model
1173
+ ) -> CreateViewResponse:
1174
+ """Create View
1174
1175
 
1175
- Create Model is used to create a 'Shaped Model' that can be used for any down-stream retrieval-search, ranking-recommendation and user-understanding juse-case. The request is composed of three top-level objects: 1. Model - contains model configuration details. 2. Connectors - contains the 'Shaped Datasets' used by the model. 3. Fetch - contains fetch queries used to source data required by the model. Events is the only required data format. Users, items and filters are optional. The create model endpoint will do some validation of the input request (including verifying connected datasets are active and validating the fetch SQL). It then asynchronously provisions your data pipelines, and training and serving infrastructure. Use the View Model and List Models endpoints to view the status of the underlying asynchronous setup request.
1176
1176
 
1177
1177
  :param x_api_key: (required)
1178
1178
  :type x_api_key: str
1179
- :param create_model_arguments: (required)
1180
- :type create_model_arguments: CreateModelArguments
1179
+ :param request1: (required)
1180
+ :type request1: Request1
1181
1181
  :param _request_timeout: timeout setting for this request. If one
1182
1182
  number provided, it will be total request
1183
1183
  timeout. It can also be a pair (tuple) of
@@ -1200,9 +1200,9 @@ class ModelManagementApi:
1200
1200
  :return: Returns the result object.
1201
1201
  """ # noqa: E501
1202
1202
 
1203
- _param = self._post_create_models_post_serialize(
1203
+ _param = self._post_create_view_views_post_serialize(
1204
1204
  x_api_key=x_api_key,
1205
- create_model_arguments=create_model_arguments,
1205
+ request1=request1,
1206
1206
  _request_auth=_request_auth,
1207
1207
  _content_type=_content_type,
1208
1208
  _headers=_headers,
@@ -1210,7 +1210,7 @@ class ModelManagementApi:
1210
1210
  )
1211
1211
 
1212
1212
  _response_types_map: Dict[str, Optional[str]] = {
1213
- '200': "CreateModelResponse",
1213
+ '200': "CreateViewResponse",
1214
1214
  '422': "HTTPValidationError",
1215
1215
  }
1216
1216
  response_data = self.api_client.call_api(
@@ -1225,10 +1225,10 @@ class ModelManagementApi:
1225
1225
 
1226
1226
 
1227
1227
  @validate_call
1228
- def post_create_models_post_with_http_info(
1228
+ def post_create_view_views_post_with_http_info(
1229
1229
  self,
1230
1230
  x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
1231
- create_model_arguments: CreateModelArguments,
1231
+ request1: Request1,
1232
1232
  _request_timeout: Union[
1233
1233
  None,
1234
1234
  Annotated[StrictFloat, Field(gt=0)],
@@ -1241,15 +1241,14 @@ class ModelManagementApi:
1241
1241
  _content_type: Optional[StrictStr] = None,
1242
1242
  _headers: Optional[Dict[StrictStr, Any]] = None,
1243
1243
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1244
- ) -> ApiResponse[CreateModelResponse]:
1245
- """Create Model
1244
+ ) -> ApiResponse[CreateViewResponse]:
1245
+ """Create View
1246
1246
 
1247
- Create Model is used to create a 'Shaped Model' that can be used for any down-stream retrieval-search, ranking-recommendation and user-understanding juse-case. The request is composed of three top-level objects: 1. Model - contains model configuration details. 2. Connectors - contains the 'Shaped Datasets' used by the model. 3. Fetch - contains fetch queries used to source data required by the model. Events is the only required data format. Users, items and filters are optional. The create model endpoint will do some validation of the input request (including verifying connected datasets are active and validating the fetch SQL). It then asynchronously provisions your data pipelines, and training and serving infrastructure. Use the View Model and List Models endpoints to view the status of the underlying asynchronous setup request.
1248
1247
 
1249
1248
  :param x_api_key: (required)
1250
1249
  :type x_api_key: str
1251
- :param create_model_arguments: (required)
1252
- :type create_model_arguments: CreateModelArguments
1250
+ :param request1: (required)
1251
+ :type request1: Request1
1253
1252
  :param _request_timeout: timeout setting for this request. If one
1254
1253
  number provided, it will be total request
1255
1254
  timeout. It can also be a pair (tuple) of
@@ -1272,9 +1271,9 @@ class ModelManagementApi:
1272
1271
  :return: Returns the result object.
1273
1272
  """ # noqa: E501
1274
1273
 
1275
- _param = self._post_create_models_post_serialize(
1274
+ _param = self._post_create_view_views_post_serialize(
1276
1275
  x_api_key=x_api_key,
1277
- create_model_arguments=create_model_arguments,
1276
+ request1=request1,
1278
1277
  _request_auth=_request_auth,
1279
1278
  _content_type=_content_type,
1280
1279
  _headers=_headers,
@@ -1282,7 +1281,7 @@ class ModelManagementApi:
1282
1281
  )
1283
1282
 
1284
1283
  _response_types_map: Dict[str, Optional[str]] = {
1285
- '200': "CreateModelResponse",
1284
+ '200': "CreateViewResponse",
1286
1285
  '422': "HTTPValidationError",
1287
1286
  }
1288
1287
  response_data = self.api_client.call_api(
@@ -1297,10 +1296,10 @@ class ModelManagementApi:
1297
1296
 
1298
1297
 
1299
1298
  @validate_call
1300
- def post_create_models_post_without_preload_content(
1299
+ def post_create_view_views_post_without_preload_content(
1301
1300
  self,
1302
1301
  x_api_key: Annotated[str, Field(min_length=40, strict=True, max_length=40)],
1303
- create_model_arguments: CreateModelArguments,
1302
+ request1: Request1,
1304
1303
  _request_timeout: Union[
1305
1304
  None,
1306
1305
  Annotated[StrictFloat, Field(gt=0)],
@@ -1314,14 +1313,13 @@ class ModelManagementApi:
1314
1313
  _headers: Optional[Dict[StrictStr, Any]] = None,
1315
1314
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1316
1315
  ) -> RESTResponseType:
1317
- """Create Model
1316
+ """Create View
1318
1317
 
1319
- Create Model is used to create a 'Shaped Model' that can be used for any down-stream retrieval-search, ranking-recommendation and user-understanding juse-case. The request is composed of three top-level objects: 1. Model - contains model configuration details. 2. Connectors - contains the 'Shaped Datasets' used by the model. 3. Fetch - contains fetch queries used to source data required by the model. Events is the only required data format. Users, items and filters are optional. The create model endpoint will do some validation of the input request (including verifying connected datasets are active and validating the fetch SQL). It then asynchronously provisions your data pipelines, and training and serving infrastructure. Use the View Model and List Models endpoints to view the status of the underlying asynchronous setup request.
1320
1318
 
1321
1319
  :param x_api_key: (required)
1322
1320
  :type x_api_key: str
1323
- :param create_model_arguments: (required)
1324
- :type create_model_arguments: CreateModelArguments
1321
+ :param request1: (required)
1322
+ :type request1: Request1
1325
1323
  :param _request_timeout: timeout setting for this request. If one
1326
1324
  number provided, it will be total request
1327
1325
  timeout. It can also be a pair (tuple) of
@@ -1344,9 +1342,9 @@ class ModelManagementApi:
1344
1342
  :return: Returns the result object.
1345
1343
  """ # noqa: E501
1346
1344
 
1347
- _param = self._post_create_models_post_serialize(
1345
+ _param = self._post_create_view_views_post_serialize(
1348
1346
  x_api_key=x_api_key,
1349
- create_model_arguments=create_model_arguments,
1347
+ request1=request1,
1350
1348
  _request_auth=_request_auth,
1351
1349
  _content_type=_content_type,
1352
1350
  _headers=_headers,
@@ -1354,7 +1352,7 @@ class ModelManagementApi:
1354
1352
  )
1355
1353
 
1356
1354
  _response_types_map: Dict[str, Optional[str]] = {
1357
- '200': "CreateModelResponse",
1355
+ '200': "CreateViewResponse",
1358
1356
  '422': "HTTPValidationError",
1359
1357
  }
1360
1358
  response_data = self.api_client.call_api(
@@ -1364,10 +1362,10 @@ class ModelManagementApi:
1364
1362
  return response_data.response
1365
1363
 
1366
1364
 
1367
- def _post_create_models_post_serialize(
1365
+ def _post_create_view_views_post_serialize(
1368
1366
  self,
1369
1367
  x_api_key,
1370
- create_model_arguments,
1368
+ request1,
1371
1369
  _request_auth,
1372
1370
  _content_type,
1373
1371
  _headers,
@@ -1395,8 +1393,8 @@ class ModelManagementApi:
1395
1393
  _header_params['x-api-key'] = x_api_key
1396
1394
  # process the form parameters
1397
1395
  # process the body parameter
1398
- if create_model_arguments is not None:
1399
- _body_params = create_model_arguments
1396
+ if request1 is not None:
1397
+ _body_params = request1
1400
1398
 
1401
1399
 
1402
1400
  # set the HTTP header `Accept`
@@ -1427,7 +1425,7 @@ class ModelManagementApi:
1427
1425
 
1428
1426
  return self.api_client.param_serialize(
1429
1427
  method='POST',
1430
- resource_path='/models',
1428
+ resource_path='/views',
1431
1429
  path_params=_path_params,
1432
1430
  query_params=_query_params,
1433
1431
  header_params=_header_params,