shaped 2.0.1__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.1.dist-info → shaped-2.0.2.dist-info}/METADATA +140 -5
  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.1.dist-info/RECORD +0 -73
  320. shaped-2.0.1.dist-info/entry_points.txt +0 -2
  321. {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/WHEEL +0 -0
  322. {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/top_level.txt +0 -0
  323. {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/zip-safe +0 -0
@@ -0,0 +1,130 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Shaped API
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. 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
+
8
+ The version of the OpenAPI document: 2.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from shaped.autogen.models.mode1 import Mode1
23
+ from typing import Optional, Set
24
+ from typing_extensions import Self
25
+
26
+ class ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig(BaseModel):
27
+ """
28
+ ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig
29
+ """ # noqa: E501
30
+ policy_type: Optional[StrictStr] = 'recently-popular'
31
+ name: Optional[StrictStr] = None
32
+ event_values: Optional[List[StrictStr]] = None
33
+ mode: Optional[Mode1] = None
34
+ additional_properties: Dict[str, Any] = {}
35
+ __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "mode"]
36
+
37
+ @field_validator('policy_type')
38
+ def policy_type_validate_enum(cls, value):
39
+ """Validates the enum"""
40
+ if value is None:
41
+ return value
42
+
43
+ if value not in set(['recently-popular']):
44
+ raise ValueError("must be one of enum values ('recently-popular')")
45
+ return value
46
+
47
+ model_config = ConfigDict(
48
+ populate_by_name=True,
49
+ validate_assignment=True,
50
+ protected_namespaces=(),
51
+ )
52
+
53
+
54
+ def to_str(self) -> str:
55
+ """Returns the string representation of the model using alias"""
56
+ return pprint.pformat(self.model_dump(by_alias=True))
57
+
58
+ def to_json(self) -> str:
59
+ """Returns the JSON representation of the model using alias"""
60
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
61
+ return json.dumps(self.to_dict())
62
+
63
+ @classmethod
64
+ def from_json(cls, json_str: str) -> Optional[Self]:
65
+ """Create an instance of ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig from a JSON string"""
66
+ return cls.from_dict(json.loads(json_str))
67
+
68
+ def to_dict(self) -> Dict[str, Any]:
69
+ """Return the dictionary representation of the model using alias.
70
+
71
+ This has the following differences from calling pydantic's
72
+ `self.model_dump(by_alias=True)`:
73
+
74
+ * `None` is only added to the output dict for nullable fields that
75
+ were set at model initialization. Other fields with value `None`
76
+ are ignored.
77
+ * Fields in `self.additional_properties` are added to the output dict.
78
+ """
79
+ excluded_fields: Set[str] = set([
80
+ "additional_properties",
81
+ ])
82
+
83
+ _dict = self.model_dump(
84
+ by_alias=True,
85
+ exclude=excluded_fields,
86
+ exclude_none=True,
87
+ )
88
+ # override the default output from pydantic by calling `to_dict()` of mode
89
+ if self.mode:
90
+ _dict['mode'] = self.mode.to_dict()
91
+ # puts key-value pairs in additional_properties in the top level
92
+ if self.additional_properties is not None:
93
+ for _key, _value in self.additional_properties.items():
94
+ _dict[_key] = _value
95
+
96
+ # set to None if name (nullable) is None
97
+ # and model_fields_set contains the field
98
+ if self.name is None and "name" in self.model_fields_set:
99
+ _dict['name'] = None
100
+
101
+ # set to None if event_values (nullable) is None
102
+ # and model_fields_set contains the field
103
+ if self.event_values is None and "event_values" in self.model_fields_set:
104
+ _dict['event_values'] = None
105
+
106
+ return _dict
107
+
108
+ @classmethod
109
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
110
+ """Create an instance of ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig from a dict"""
111
+ if obj is None:
112
+ return None
113
+
114
+ if not isinstance(obj, dict):
115
+ return cls.model_validate(obj)
116
+
117
+ _obj = cls.model_validate({
118
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'recently-popular',
119
+ "name": obj.get("name"),
120
+ "event_values": obj.get("event_values"),
121
+ "mode": Mode1.from_dict(obj["mode"]) if obj.get("mode") is not None else None
122
+ })
123
+ # store additional fields in additional_properties
124
+ for _key in obj.keys():
125
+ if _key not in cls.__properties:
126
+ _obj.additional_properties[_key] = obj.get(_key)
127
+
128
+ return _obj
129
+
130
+
@@ -0,0 +1,123 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Shaped API
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. 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
+
8
+ The version of the OpenAPI document: 2.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from shaped.autogen.models.time_frequency import TimeFrequency
23
+ from shaped.autogen.models.time_window import TimeWindow
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig(BaseModel):
28
+ """
29
+ ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig
30
+ """ # noqa: E501
31
+ policy_type: Optional[StrictStr] = 'rising-popular'
32
+ name: Optional[StrictStr] = None
33
+ event_values: Optional[List[StrictStr]] = None
34
+ time_window: Optional[TimeWindow] = None
35
+ time_frequency: Optional[TimeFrequency] = None
36
+ __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "time_window", "time_frequency"]
37
+
38
+ @field_validator('policy_type')
39
+ def policy_type_validate_enum(cls, value):
40
+ """Validates the enum"""
41
+ if value is None:
42
+ return value
43
+
44
+ if value not in set(['rising-popular']):
45
+ raise ValueError("must be one of enum values ('rising-popular')")
46
+ return value
47
+
48
+ model_config = ConfigDict(
49
+ populate_by_name=True,
50
+ validate_assignment=True,
51
+ protected_namespaces=(),
52
+ )
53
+
54
+
55
+ def to_str(self) -> str:
56
+ """Returns the string representation of the model using alias"""
57
+ return pprint.pformat(self.model_dump(by_alias=True))
58
+
59
+ def to_json(self) -> str:
60
+ """Returns the JSON representation of the model using alias"""
61
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
62
+ return json.dumps(self.to_dict())
63
+
64
+ @classmethod
65
+ def from_json(cls, json_str: str) -> Optional[Self]:
66
+ """Create an instance of ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig from a JSON string"""
67
+ return cls.from_dict(json.loads(json_str))
68
+
69
+ def to_dict(self) -> Dict[str, Any]:
70
+ """Return the dictionary representation of the model using alias.
71
+
72
+ This has the following differences from calling pydantic's
73
+ `self.model_dump(by_alias=True)`:
74
+
75
+ * `None` is only added to the output dict for nullable fields that
76
+ were set at model initialization. Other fields with value `None`
77
+ are ignored.
78
+ """
79
+ excluded_fields: Set[str] = set([
80
+ ])
81
+
82
+ _dict = self.model_dump(
83
+ by_alias=True,
84
+ exclude=excluded_fields,
85
+ exclude_none=True,
86
+ )
87
+ # override the default output from pydantic by calling `to_dict()` of time_window
88
+ if self.time_window:
89
+ _dict['time_window'] = self.time_window.to_dict()
90
+ # override the default output from pydantic by calling `to_dict()` of time_frequency
91
+ if self.time_frequency:
92
+ _dict['time_frequency'] = self.time_frequency.to_dict()
93
+ # set to None if name (nullable) is None
94
+ # and model_fields_set contains the field
95
+ if self.name is None and "name" in self.model_fields_set:
96
+ _dict['name'] = None
97
+
98
+ # set to None if event_values (nullable) is None
99
+ # and model_fields_set contains the field
100
+ if self.event_values is None and "event_values" in self.model_fields_set:
101
+ _dict['event_values'] = None
102
+
103
+ return _dict
104
+
105
+ @classmethod
106
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107
+ """Create an instance of ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig from a dict"""
108
+ if obj is None:
109
+ return None
110
+
111
+ if not isinstance(obj, dict):
112
+ return cls.model_validate(obj)
113
+
114
+ _obj = cls.model_validate({
115
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'rising-popular',
116
+ "name": obj.get("name"),
117
+ "event_values": obj.get("event_values"),
118
+ "time_window": TimeWindow.from_dict(obj["time_window"]) if obj.get("time_window") is not None else None,
119
+ "time_frequency": TimeFrequency.from_dict(obj["time_frequency"]) if obj.get("time_frequency") is not None else None
120
+ })
121
+ return _obj
122
+
123
+
@@ -0,0 +1,224 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Shaped API
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. 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
+
8
+ The version of the OpenAPI document: 2.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional, Union
22
+ from shaped.autogen.models.attn_dropout_prob import AttnDropoutProb
23
+ from shaped.autogen.models.batch_size import BatchSize
24
+ from shaped.autogen.models.hidden_dropout_prob import HiddenDropoutProb
25
+ from shaped.autogen.models.hidden_size1 import HiddenSize1
26
+ from shaped.autogen.models.inner_size1 import InnerSize1
27
+ from shaped.autogen.models.learning_rate2 import LearningRate2
28
+ from shaped.autogen.models.loss_types import LossTypes
29
+ from shaped.autogen.models.max_seq_length2 import MaxSeqLength2
30
+ from shaped.autogen.models.n_heads import NHeads
31
+ from shaped.autogen.models.n_layers import NLayers
32
+ from shaped.autogen.models.sampling_strategy import SamplingStrategy
33
+ from typing import Optional, Set
34
+ from typing_extensions import Self
35
+
36
+ class ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig(BaseModel):
37
+ """
38
+ ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig
39
+ """ # noqa: E501
40
+ policy_type: Optional[StrictStr] = 'sasrec'
41
+ name: Optional[StrictStr] = None
42
+ event_values: Optional[List[StrictStr]] = None
43
+ batch_size: Optional[BatchSize] = None
44
+ eval_batch_size: Optional[StrictInt] = Field(default=1000, description="Batch size used during model evaluation.")
45
+ n_epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
46
+ negative_samples_count: Optional[StrictInt] = Field(default=2, description="Number of negative samples per positive sample for contrastive learning.")
47
+ device: Optional[StrictStr] = None
48
+ hidden_size: Optional[HiddenSize1] = None
49
+ inner_size: Optional[InnerSize1] = None
50
+ learning_rate: Optional[LearningRate2] = None
51
+ attn_dropout_prob: Optional[AttnDropoutProb] = None
52
+ hidden_act: Optional[StrictStr] = 'gelu'
53
+ hidden_dropout_prob: Optional[HiddenDropoutProb] = None
54
+ n_heads: Optional[NHeads] = None
55
+ n_layers: Optional[NLayers] = None
56
+ layer_norm_eps: Optional[Union[StrictFloat, StrictInt]] = 1.0E-12
57
+ initializer_range: Optional[Union[StrictFloat, StrictInt]] = 0.02
58
+ mask_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.2, description="Fraction of tokens to mask during training.")
59
+ loss_type: Optional[LossTypes] = None
60
+ max_seq_length: Optional[MaxSeqLength2] = None
61
+ sample_strategy: Optional[SamplingStrategy] = None
62
+ append_item_features: Optional[StrictBool] = False
63
+ append_item_embeddings: Optional[StrictBool] = False
64
+ use_candidate_embeddings: Optional[StrictBool] = False
65
+ sample_seed: Optional[StrictInt] = 42
66
+ sample_ratio: Optional[Union[StrictFloat, StrictInt]] = 0.8
67
+ eval_step: Optional[StrictInt] = 1
68
+ early_stopping_step: Optional[StrictInt] = 5
69
+ additional_properties: Dict[str, Any] = {}
70
+ __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "eval_batch_size", "n_epochs", "negative_samples_count", "device", "hidden_size", "inner_size", "learning_rate", "attn_dropout_prob", "hidden_act", "hidden_dropout_prob", "n_heads", "n_layers", "layer_norm_eps", "initializer_range", "mask_rate", "loss_type", "max_seq_length", "sample_strategy", "append_item_features", "append_item_embeddings", "use_candidate_embeddings", "sample_seed", "sample_ratio", "eval_step", "early_stopping_step"]
71
+
72
+ @field_validator('policy_type')
73
+ def policy_type_validate_enum(cls, value):
74
+ """Validates the enum"""
75
+ if value is None:
76
+ return value
77
+
78
+ if value not in set(['sasrec']):
79
+ raise ValueError("must be one of enum values ('sasrec')")
80
+ return value
81
+
82
+ model_config = ConfigDict(
83
+ populate_by_name=True,
84
+ validate_assignment=True,
85
+ protected_namespaces=(),
86
+ )
87
+
88
+
89
+ def to_str(self) -> str:
90
+ """Returns the string representation of the model using alias"""
91
+ return pprint.pformat(self.model_dump(by_alias=True))
92
+
93
+ def to_json(self) -> str:
94
+ """Returns the JSON representation of the model using alias"""
95
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
96
+ return json.dumps(self.to_dict())
97
+
98
+ @classmethod
99
+ def from_json(cls, json_str: str) -> Optional[Self]:
100
+ """Create an instance of ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig from a JSON string"""
101
+ return cls.from_dict(json.loads(json_str))
102
+
103
+ def to_dict(self) -> Dict[str, Any]:
104
+ """Return the dictionary representation of the model using alias.
105
+
106
+ This has the following differences from calling pydantic's
107
+ `self.model_dump(by_alias=True)`:
108
+
109
+ * `None` is only added to the output dict for nullable fields that
110
+ were set at model initialization. Other fields with value `None`
111
+ are ignored.
112
+ * Fields in `self.additional_properties` are added to the output dict.
113
+ """
114
+ excluded_fields: Set[str] = set([
115
+ "additional_properties",
116
+ ])
117
+
118
+ _dict = self.model_dump(
119
+ by_alias=True,
120
+ exclude=excluded_fields,
121
+ exclude_none=True,
122
+ )
123
+ # override the default output from pydantic by calling `to_dict()` of batch_size
124
+ if self.batch_size:
125
+ _dict['batch_size'] = self.batch_size.to_dict()
126
+ # override the default output from pydantic by calling `to_dict()` of hidden_size
127
+ if self.hidden_size:
128
+ _dict['hidden_size'] = self.hidden_size.to_dict()
129
+ # override the default output from pydantic by calling `to_dict()` of inner_size
130
+ if self.inner_size:
131
+ _dict['inner_size'] = self.inner_size.to_dict()
132
+ # override the default output from pydantic by calling `to_dict()` of learning_rate
133
+ if self.learning_rate:
134
+ _dict['learning_rate'] = self.learning_rate.to_dict()
135
+ # override the default output from pydantic by calling `to_dict()` of attn_dropout_prob
136
+ if self.attn_dropout_prob:
137
+ _dict['attn_dropout_prob'] = self.attn_dropout_prob.to_dict()
138
+ # override the default output from pydantic by calling `to_dict()` of hidden_dropout_prob
139
+ if self.hidden_dropout_prob:
140
+ _dict['hidden_dropout_prob'] = self.hidden_dropout_prob.to_dict()
141
+ # override the default output from pydantic by calling `to_dict()` of n_heads
142
+ if self.n_heads:
143
+ _dict['n_heads'] = self.n_heads.to_dict()
144
+ # override the default output from pydantic by calling `to_dict()` of n_layers
145
+ if self.n_layers:
146
+ _dict['n_layers'] = self.n_layers.to_dict()
147
+ # override the default output from pydantic by calling `to_dict()` of max_seq_length
148
+ if self.max_seq_length:
149
+ _dict['max_seq_length'] = self.max_seq_length.to_dict()
150
+ # puts key-value pairs in additional_properties in the top level
151
+ if self.additional_properties is not None:
152
+ for _key, _value in self.additional_properties.items():
153
+ _dict[_key] = _value
154
+
155
+ # set to None if name (nullable) is None
156
+ # and model_fields_set contains the field
157
+ if self.name is None and "name" in self.model_fields_set:
158
+ _dict['name'] = None
159
+
160
+ # set to None if event_values (nullable) is None
161
+ # and model_fields_set contains the field
162
+ if self.event_values is None and "event_values" in self.model_fields_set:
163
+ _dict['event_values'] = None
164
+
165
+ # set to None if device (nullable) is None
166
+ # and model_fields_set contains the field
167
+ if self.device is None and "device" in self.model_fields_set:
168
+ _dict['device'] = None
169
+
170
+ # set to None if sample_strategy (nullable) is None
171
+ # and model_fields_set contains the field
172
+ if self.sample_strategy is None and "sample_strategy" in self.model_fields_set:
173
+ _dict['sample_strategy'] = None
174
+
175
+ return _dict
176
+
177
+ @classmethod
178
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
179
+ """Create an instance of ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig from a dict"""
180
+ if obj is None:
181
+ return None
182
+
183
+ if not isinstance(obj, dict):
184
+ return cls.model_validate(obj)
185
+
186
+ _obj = cls.model_validate({
187
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'sasrec',
188
+ "name": obj.get("name"),
189
+ "event_values": obj.get("event_values"),
190
+ "batch_size": BatchSize.from_dict(obj["batch_size"]) if obj.get("batch_size") is not None else None,
191
+ "eval_batch_size": obj.get("eval_batch_size") if obj.get("eval_batch_size") is not None else 1000,
192
+ "n_epochs": obj.get("n_epochs") if obj.get("n_epochs") is not None else 1,
193
+ "negative_samples_count": obj.get("negative_samples_count") if obj.get("negative_samples_count") is not None else 2,
194
+ "device": obj.get("device"),
195
+ "hidden_size": HiddenSize1.from_dict(obj["hidden_size"]) if obj.get("hidden_size") is not None else None,
196
+ "inner_size": InnerSize1.from_dict(obj["inner_size"]) if obj.get("inner_size") is not None else None,
197
+ "learning_rate": LearningRate2.from_dict(obj["learning_rate"]) if obj.get("learning_rate") is not None else None,
198
+ "attn_dropout_prob": AttnDropoutProb.from_dict(obj["attn_dropout_prob"]) if obj.get("attn_dropout_prob") is not None else None,
199
+ "hidden_act": obj.get("hidden_act") if obj.get("hidden_act") is not None else 'gelu',
200
+ "hidden_dropout_prob": HiddenDropoutProb.from_dict(obj["hidden_dropout_prob"]) if obj.get("hidden_dropout_prob") is not None else None,
201
+ "n_heads": NHeads.from_dict(obj["n_heads"]) if obj.get("n_heads") is not None else None,
202
+ "n_layers": NLayers.from_dict(obj["n_layers"]) if obj.get("n_layers") is not None else None,
203
+ "layer_norm_eps": obj.get("layer_norm_eps") if obj.get("layer_norm_eps") is not None else 1.0E-12,
204
+ "initializer_range": obj.get("initializer_range") if obj.get("initializer_range") is not None else 0.02,
205
+ "mask_rate": obj.get("mask_rate") if obj.get("mask_rate") is not None else 0.2,
206
+ "loss_type": obj.get("loss_type"),
207
+ "max_seq_length": MaxSeqLength2.from_dict(obj["max_seq_length"]) if obj.get("max_seq_length") is not None else None,
208
+ "sample_strategy": obj.get("sample_strategy"),
209
+ "append_item_features": obj.get("append_item_features") if obj.get("append_item_features") is not None else False,
210
+ "append_item_embeddings": obj.get("append_item_embeddings") if obj.get("append_item_embeddings") is not None else False,
211
+ "use_candidate_embeddings": obj.get("use_candidate_embeddings") if obj.get("use_candidate_embeddings") is not None else False,
212
+ "sample_seed": obj.get("sample_seed") if obj.get("sample_seed") is not None else 42,
213
+ "sample_ratio": obj.get("sample_ratio") if obj.get("sample_ratio") is not None else 0.8,
214
+ "eval_step": obj.get("eval_step") if obj.get("eval_step") is not None else 1,
215
+ "early_stopping_step": obj.get("early_stopping_step") if obj.get("early_stopping_step") is not None else 5
216
+ })
217
+ # store additional fields in additional_properties
218
+ for _key in obj.keys():
219
+ if _key not in cls.__properties:
220
+ _obj.additional_properties[_key] = obj.get(_key)
221
+
222
+ return _obj
223
+
224
+
@@ -0,0 +1,119 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Shaped API
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. 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
+
8
+ The version of the OpenAPI document: 2.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from shaped.autogen.models.factors1 import Factors1
23
+ from typing import Optional, Set
24
+ from typing_extensions import Self
25
+
26
+ class ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig(BaseModel):
27
+ """
28
+ ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig
29
+ """ # noqa: E501
30
+ policy_type: Optional[StrictStr] = 'svd'
31
+ name: Optional[StrictStr] = None
32
+ event_values: Optional[List[StrictStr]] = None
33
+ factors: Optional[Factors1] = None
34
+ num_epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
35
+ __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "factors", "num_epochs"]
36
+
37
+ @field_validator('policy_type')
38
+ def policy_type_validate_enum(cls, value):
39
+ """Validates the enum"""
40
+ if value is None:
41
+ return value
42
+
43
+ if value not in set(['svd']):
44
+ raise ValueError("must be one of enum values ('svd')")
45
+ return value
46
+
47
+ model_config = ConfigDict(
48
+ populate_by_name=True,
49
+ validate_assignment=True,
50
+ protected_namespaces=(),
51
+ )
52
+
53
+
54
+ def to_str(self) -> str:
55
+ """Returns the string representation of the model using alias"""
56
+ return pprint.pformat(self.model_dump(by_alias=True))
57
+
58
+ def to_json(self) -> str:
59
+ """Returns the JSON representation of the model using alias"""
60
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
61
+ return json.dumps(self.to_dict())
62
+
63
+ @classmethod
64
+ def from_json(cls, json_str: str) -> Optional[Self]:
65
+ """Create an instance of ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig from a JSON string"""
66
+ return cls.from_dict(json.loads(json_str))
67
+
68
+ def to_dict(self) -> Dict[str, Any]:
69
+ """Return the dictionary representation of the model using alias.
70
+
71
+ This has the following differences from calling pydantic's
72
+ `self.model_dump(by_alias=True)`:
73
+
74
+ * `None` is only added to the output dict for nullable fields that
75
+ were set at model initialization. Other fields with value `None`
76
+ are ignored.
77
+ """
78
+ excluded_fields: Set[str] = set([
79
+ ])
80
+
81
+ _dict = self.model_dump(
82
+ by_alias=True,
83
+ exclude=excluded_fields,
84
+ exclude_none=True,
85
+ )
86
+ # override the default output from pydantic by calling `to_dict()` of factors
87
+ if self.factors:
88
+ _dict['factors'] = self.factors.to_dict()
89
+ # set to None if name (nullable) is None
90
+ # and model_fields_set contains the field
91
+ if self.name is None and "name" in self.model_fields_set:
92
+ _dict['name'] = None
93
+
94
+ # set to None if event_values (nullable) is None
95
+ # and model_fields_set contains the field
96
+ if self.event_values is None and "event_values" in self.model_fields_set:
97
+ _dict['event_values'] = None
98
+
99
+ return _dict
100
+
101
+ @classmethod
102
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
103
+ """Create an instance of ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig from a dict"""
104
+ if obj is None:
105
+ return None
106
+
107
+ if not isinstance(obj, dict):
108
+ return cls.model_validate(obj)
109
+
110
+ _obj = cls.model_validate({
111
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'svd',
112
+ "name": obj.get("name"),
113
+ "event_values": obj.get("event_values"),
114
+ "factors": Factors1.from_dict(obj["factors"]) if obj.get("factors") is not None else None,
115
+ "num_epochs": obj.get("num_epochs") if obj.get("num_epochs") is not None else 1
116
+ })
117
+ return _obj
118
+
119
+