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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (341) hide show
  1. shaped/__init__.py +59 -4
  2. shaped/autogen/__init__.py +527 -66
  3. shaped/autogen/api/__init__.py +4 -3
  4. shaped/autogen/api/engine_api.py +1467 -0
  5. shaped/autogen/api/{dataset_api.py → query_api.py} +159 -194
  6. shaped/autogen/api/table_api.py +1494 -0
  7. shaped/autogen/api/{model_management_api.py → view_api.py} +179 -181
  8. shaped/autogen/api_client.py +18 -11
  9. shaped/autogen/configuration.py +22 -9
  10. shaped/autogen/exceptions.py +25 -5
  11. shaped/autogen/models/__init__.py +247 -52
  12. shaped/autogen/models/ai_enrichment_view_config.py +123 -0
  13. shaped/autogen/models/{path.py → algorithm.py} +19 -19
  14. shaped/autogen/models/amplitude_table_config.py +106 -0
  15. shaped/autogen/models/ascending.py +148 -0
  16. shaped/autogen/models/attn_dropout_prob.py +136 -0
  17. shaped/autogen/models/attribute_journey.py +124 -0
  18. shaped/autogen/models/attribute_value.py +178 -0
  19. shaped/autogen/models/autoscaling_config.py +95 -0
  20. shaped/autogen/models/aws_pinpoint_table_config.py +108 -0
  21. shaped/autogen/models/batch_size.py +136 -0
  22. shaped/autogen/models/batch_size1.py +136 -0
  23. shaped/autogen/models/batch_size2.py +136 -0
  24. shaped/autogen/models/big_query_table_config.py +147 -0
  25. shaped/autogen/models/bm25.py +136 -0
  26. shaped/autogen/models/boosted_reorder_step.py +125 -0
  27. shaped/autogen/models/canary_rollout.py +99 -0
  28. shaped/autogen/models/candidate_attributes_retrieve_step.py +113 -0
  29. shaped/autogen/models/candidate_ids_retrieve_step.py +113 -0
  30. shaped/autogen/models/candidate_retrieval_strategy.py +41 -0
  31. shaped/autogen/models/clickhouse_table_config.py +146 -0
  32. shaped/autogen/models/column_order_retrieve_step.py +123 -0
  33. shaped/autogen/models/column_ordering.py +91 -0
  34. shaped/autogen/models/create_table_response.py +87 -0
  35. shaped/autogen/models/create_view_response.py +87 -0
  36. shaped/autogen/models/custom_table_config.py +135 -0
  37. shaped/autogen/models/data_compute_config.py +89 -0
  38. shaped/autogen/models/data_config.py +145 -0
  39. shaped/autogen/models/data_config_interaction_table.py +146 -0
  40. shaped/autogen/models/data_split_config.py +88 -0
  41. shaped/autogen/models/data_split_strategy.py +37 -0
  42. shaped/autogen/models/data_tier.py +37 -0
  43. shaped/autogen/models/default.py +246 -0
  44. shaped/autogen/models/delete_engine_response.py +87 -0
  45. shaped/autogen/models/delete_table_response.py +87 -0
  46. shaped/autogen/models/delete_view_response.py +87 -0
  47. shaped/autogen/models/deployment_config.py +117 -0
  48. shaped/autogen/models/distance_function.py +38 -0
  49. shaped/autogen/models/diversity_reorder_step.py +137 -0
  50. shaped/autogen/models/dropout_rate.py +136 -0
  51. shaped/autogen/models/dynamo_db_table_config.py +160 -0
  52. shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +138 -0
  53. shaped/autogen/models/embedder_batch_size.py +136 -0
  54. shaped/autogen/models/embedding_config.py +93 -0
  55. shaped/autogen/models/embedding_dim.py +136 -0
  56. shaped/autogen/models/embedding_dims.py +136 -0
  57. shaped/autogen/models/embedding_size.py +136 -0
  58. shaped/autogen/models/encoder.py +140 -0
  59. shaped/autogen/models/encoding_pooling_strategy.py +38 -0
  60. shaped/autogen/models/engine.py +109 -0
  61. shaped/autogen/models/engine_config_v2.py +152 -0
  62. shaped/autogen/models/engine_details_response.py +120 -0
  63. shaped/autogen/models/engine_schema.py +113 -0
  64. shaped/autogen/models/engine_schema_user_inner.py +146 -0
  65. shaped/autogen/models/entity_config.py +109 -0
  66. shaped/autogen/models/entity_journey.py +161 -0
  67. shaped/autogen/models/entity_type.py +38 -0
  68. shaped/autogen/models/evaluation_config.py +92 -0
  69. shaped/autogen/models/exploration_reorder_step.py +125 -0
  70. shaped/autogen/models/expression_filter_step.py +106 -0
  71. shaped/autogen/models/factors.py +136 -0
  72. shaped/autogen/models/factors1.py +136 -0
  73. shaped/autogen/models/feature.py +90 -0
  74. shaped/autogen/models/feature_type.py +60 -0
  75. shaped/autogen/models/file_table_config.py +112 -0
  76. shaped/autogen/models/filter_config.py +99 -0
  77. shaped/autogen/models/filter_dataset.py +164 -0
  78. shaped/autogen/models/filter_index_type.py +36 -0
  79. shaped/autogen/models/filter_retrieve_step.py +113 -0
  80. shaped/autogen/models/filter_step_explanation.py +165 -0
  81. shaped/autogen/models/filter_table.py +140 -0
  82. shaped/autogen/models/filter_type.py +134 -0
  83. shaped/autogen/models/global_filter.py +102 -0
  84. shaped/autogen/models/hidden_dropout_prob.py +136 -0
  85. shaped/autogen/models/hidden_size.py +136 -0
  86. shaped/autogen/models/hidden_size1.py +136 -0
  87. shaped/autogen/models/http_problem_response.py +115 -0
  88. shaped/autogen/models/http_validation_error.py +2 -2
  89. shaped/autogen/models/hugging_face_encoder.py +115 -0
  90. shaped/autogen/models/iceberg_table_config.py +154 -0
  91. shaped/autogen/models/index_config.py +101 -0
  92. shaped/autogen/models/inner_entity_id.py +144 -0
  93. shaped/autogen/models/inner_size.py +136 -0
  94. shaped/autogen/models/inner_size1.py +136 -0
  95. shaped/autogen/models/inner_uid.py +144 -0
  96. shaped/autogen/models/interaction_config.py +122 -0
  97. shaped/autogen/models/interaction_pooling_encoder.py +104 -0
  98. shaped/autogen/models/interaction_round_robin_encoder.py +104 -0
  99. shaped/autogen/models/item_attribute_pooling_encoder.py +111 -0
  100. shaped/autogen/models/journey.py +140 -0
  101. shaped/autogen/models/kafka_table_config.py +129 -0
  102. shaped/autogen/models/kinesis_table_config.py +140 -0
  103. shaped/autogen/models/kinesis_table_config_column_schema_value.py +136 -0
  104. shaped/autogen/models/label.py +90 -0
  105. shaped/autogen/models/label_type.py +36 -0
  106. shaped/autogen/models/laplace_smoothing.py +136 -0
  107. shaped/autogen/models/latency_scaling_policy.py +112 -0
  108. shaped/autogen/models/learning_rate.py +136 -0
  109. shaped/autogen/models/learning_rate1.py +136 -0
  110. shaped/autogen/models/learning_rate2.py +136 -0
  111. shaped/autogen/models/learning_rate3.py +136 -0
  112. shaped/autogen/models/lexical_search_mode.py +99 -0
  113. shaped/autogen/models/list_engines_response.py +95 -0
  114. shaped/autogen/models/list_tables_response.py +95 -0
  115. shaped/autogen/models/list_views_response.py +95 -0
  116. shaped/autogen/models/location_inner.py +138 -0
  117. shaped/autogen/models/loss_types.py +37 -0
  118. shaped/autogen/models/lr.py +136 -0
  119. shaped/autogen/models/lr1.py +136 -0
  120. shaped/autogen/models/lr2.py +136 -0
  121. shaped/autogen/models/max_depth.py +136 -0
  122. shaped/autogen/models/max_leaves.py +136 -0
  123. shaped/autogen/models/max_seq_length.py +136 -0
  124. shaped/autogen/models/max_seq_length1.py +136 -0
  125. shaped/autogen/models/max_seq_length2.py +136 -0
  126. shaped/autogen/models/mode.py +134 -0
  127. shaped/autogen/models/mode1.py +136 -0
  128. shaped/autogen/models/mode2.py +150 -0
  129. shaped/autogen/models/models_inner.py +308 -0
  130. shaped/autogen/models/mongo_db_table_config.py +147 -0
  131. shaped/autogen/models/mssql_table_config.py +155 -0
  132. shaped/autogen/models/{my_sql_dataset_config.py → my_sql_table_config.py} +45 -28
  133. shaped/autogen/models/n_epochs.py +136 -0
  134. shaped/autogen/models/n_epochs1.py +136 -0
  135. shaped/autogen/models/n_epochs2.py +136 -0
  136. shaped/autogen/models/n_estimators.py +136 -0
  137. shaped/autogen/models/n_heads.py +136 -0
  138. shaped/autogen/models/n_layers.py +136 -0
  139. shaped/autogen/models/neg_per_positive.py +136 -0
  140. shaped/autogen/models/negative_samples_count.py +136 -0
  141. shaped/autogen/models/ngram_tokenizer.py +103 -0
  142. shaped/autogen/models/no_op_config.py +117 -0
  143. shaped/autogen/models/num_blocks.py +136 -0
  144. shaped/autogen/models/num_heads.py +136 -0
  145. shaped/autogen/models/num_leaves.py +136 -0
  146. shaped/autogen/models/objective.py +40 -0
  147. shaped/autogen/models/objective1.py +134 -0
  148. shaped/autogen/models/online_store_config.py +89 -0
  149. shaped/autogen/models/pagination_config.py +87 -0
  150. shaped/autogen/models/parameter_definition.py +96 -0
  151. shaped/autogen/models/parameters_value.py +240 -0
  152. shaped/autogen/models/passthrough_score.py +104 -0
  153. shaped/autogen/models/personal_filter.py +104 -0
  154. shaped/autogen/models/pipeline_stage_explanation.py +118 -0
  155. shaped/autogen/models/policy.py +134 -0
  156. shaped/autogen/models/pool_fn.py +152 -0
  157. shaped/autogen/models/pooling_function.py +37 -0
  158. shaped/autogen/models/{postgres_dataset_config.py → postgres_table_config.py} +66 -28
  159. shaped/autogen/models/posthog_table_config.py +133 -0
  160. shaped/autogen/models/prebuilt_filter_step.py +113 -0
  161. shaped/autogen/models/precomputed_item_embedding.py +99 -0
  162. shaped/autogen/models/precomputed_user_embedding.py +99 -0
  163. shaped/autogen/models/query.py +136 -0
  164. shaped/autogen/models/query1.py +136 -0
  165. shaped/autogen/models/query_any_of.py +172 -0
  166. shaped/autogen/models/query_config.py +140 -0
  167. shaped/autogen/models/query_definition.py +106 -0
  168. shaped/autogen/models/query_encoder.py +194 -0
  169. shaped/autogen/models/query_explanation.py +201 -0
  170. shaped/autogen/models/query_request.py +121 -0
  171. shaped/autogen/models/query_result.py +113 -0
  172. shaped/autogen/models/query_table_config.py +99 -0
  173. shaped/autogen/models/rank_item_attribute_values_query_config.py +122 -0
  174. shaped/autogen/models/rank_query_config.py +167 -0
  175. shaped/autogen/models/rank_query_config_filter_inner.py +149 -0
  176. shaped/autogen/models/rank_query_config_reorder_inner.py +186 -0
  177. shaped/autogen/models/rank_query_config_retrieve_inner.py +265 -0
  178. shaped/autogen/models/recreate_rollout.py +97 -0
  179. shaped/autogen/models/{redshift_dataset_config.py → redshift_table_config.py} +48 -25
  180. shaped/autogen/models/reference_table_config.py +113 -0
  181. shaped/autogen/models/regularization.py +136 -0
  182. shaped/autogen/models/reorder_inner.py +149 -0
  183. shaped/autogen/models/reorder_step_explanation.py +207 -0
  184. shaped/autogen/models/request.py +378 -0
  185. shaped/autogen/models/request1.py +140 -0
  186. shaped/autogen/models/requests_per_second_scaling_policy.py +112 -0
  187. shaped/autogen/models/resource_config.py +100 -0
  188. shaped/autogen/models/response_get_view_details_views_view_name_get.py +134 -0
  189. shaped/autogen/models/result.py +132 -0
  190. shaped/autogen/models/result_embeddings_value.py +127 -0
  191. shaped/autogen/models/retrieval_scores_value.py +127 -0
  192. shaped/autogen/models/retrieve_inner.py +196 -0
  193. shaped/autogen/models/retrieve_step_explanation.py +172 -0
  194. shaped/autogen/models/retriever.py +196 -0
  195. shaped/autogen/models/retriever1.py +196 -0
  196. shaped/autogen/models/rollout_config.py +91 -0
  197. shaped/autogen/models/rudderstack_table_config.py +106 -0
  198. shaped/autogen/models/sampling_strategy.py +36 -0
  199. shaped/autogen/models/saved_query_info_response.py +103 -0
  200. shaped/autogen/models/saved_query_list_response.py +87 -0
  201. shaped/autogen/models/saved_query_request.py +115 -0
  202. shaped/autogen/models/schema_config.py +117 -0
  203. shaped/autogen/models/score.py +134 -0
  204. shaped/autogen/models/score_ensemble.py +127 -0
  205. shaped/autogen/models/score_ensemble_policy_config.py +165 -0
  206. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +755 -0
  207. shaped/autogen/models/score_step_explanation.py +224 -0
  208. shaped/autogen/models/search_config.py +105 -0
  209. shaped/autogen/models/segment_table_config.py +106 -0
  210. shaped/autogen/models/sequence_length.py +136 -0
  211. shaped/autogen/models/server_config.py +100 -0
  212. shaped/autogen/models/setup_engine_response.py +87 -0
  213. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +154 -0
  214. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +160 -0
  215. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +215 -0
  216. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +156 -0
  217. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +141 -0
  218. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +211 -0
  219. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +140 -0
  220. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +195 -0
  221. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +245 -0
  222. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +119 -0
  223. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +161 -0
  224. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +108 -0
  225. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +143 -0
  226. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +123 -0
  227. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +230 -0
  228. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +119 -0
  229. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +165 -0
  230. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +153 -0
  231. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +137 -0
  232. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +155 -0
  233. shaped/autogen/models/shopify_table_config.py +156 -0
  234. shaped/autogen/models/similarity_retrieve_step.py +123 -0
  235. shaped/autogen/models/{snowflake_dataset_config.py → snowflake_table_config.py} +47 -18
  236. shaped/autogen/models/sql_transform_type.py +37 -0
  237. shaped/autogen/models/sql_view_config.py +111 -0
  238. shaped/autogen/models/stemmer_tokenizer.py +105 -0
  239. shaped/autogen/models/step_explanation.py +137 -0
  240. shaped/autogen/models/steps_inner.py +179 -0
  241. shaped/autogen/models/strategy.py +134 -0
  242. shaped/autogen/models/table.py +102 -0
  243. shaped/autogen/models/table_deployment_type.py +38 -0
  244. shaped/autogen/models/table_insert_arguments.py +87 -0
  245. shaped/autogen/models/table_insert_response.py +87 -0
  246. shaped/autogen/models/text_encoding.py +148 -0
  247. shaped/autogen/models/text_search_retrieve_step.py +121 -0
  248. shaped/autogen/models/time_frequency.py +136 -0
  249. shaped/autogen/models/time_window.py +136 -0
  250. shaped/autogen/models/time_window_in_days.py +154 -0
  251. shaped/autogen/models/tokenizer.py +149 -0
  252. shaped/autogen/models/trained_model_encoder.py +99 -0
  253. shaped/autogen/models/training_compute_config.py +99 -0
  254. shaped/autogen/models/training_config.py +121 -0
  255. shaped/autogen/models/training_config_models_inner.py +540 -0
  256. shaped/autogen/models/training_strategy.py +37 -0
  257. shaped/autogen/models/transform_status.py +41 -0
  258. shaped/autogen/models/trending_mode.py +37 -0
  259. shaped/autogen/models/truncate_filter_step.py +106 -0
  260. shaped/autogen/models/tunable_bool.py +97 -0
  261. shaped/autogen/models/tunable_float.py +118 -0
  262. shaped/autogen/models/tunable_int.py +118 -0
  263. shaped/autogen/models/tunable_int_categorical.py +99 -0
  264. shaped/autogen/models/tunable_string.py +99 -0
  265. shaped/autogen/models/tuning_config.py +89 -0
  266. shaped/autogen/models/type.py +150 -0
  267. shaped/autogen/models/update_table_response.py +87 -0
  268. shaped/autogen/models/update_view_response.py +87 -0
  269. shaped/autogen/models/user_attribute_pooling_encoder.py +124 -0
  270. shaped/autogen/models/user_inner.py +134 -0
  271. shaped/autogen/models/val_split.py +136 -0
  272. shaped/autogen/models/validation_error.py +13 -3
  273. shaped/autogen/models/validation_error_loc_inner.py +150 -0
  274. shaped/autogen/models/value_type.py +7 -5
  275. shaped/autogen/models/vector_search_mode.py +101 -0
  276. shaped/autogen/models/view.py +104 -0
  277. shaped/autogen/models/view_details_ai.py +140 -0
  278. shaped/autogen/models/view_details_ai_schema_value.py +153 -0
  279. shaped/autogen/models/view_details_sql.py +140 -0
  280. shaped/autogen/models/view_status.py +41 -0
  281. shaped/autogen/models/weight_decay.py +136 -0
  282. shaped/autogen/models/whitespace_tokenizer.py +97 -0
  283. shaped/autogen/models/window_size.py +136 -0
  284. shaped/autogen/rest.py +10 -4
  285. shaped/cli/shaped_cli.py +163 -35
  286. shaped/client.py +591 -171
  287. shaped/config_builders.py +705 -0
  288. shaped/query_builder.py +781 -0
  289. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/METADATA +141 -6
  290. shaped-2.0.4.dist-info/RECORD +296 -0
  291. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/WHEEL +1 -1
  292. shaped-2.0.4.dist-info/entry_points.txt +2 -0
  293. shaped/autogen/api/model_inference_api.py +0 -2825
  294. shaped/autogen/models/amplitude_dataset_config.py +0 -96
  295. shaped/autogen/models/aws_pinpoint_dataset_config.py +0 -96
  296. shaped/autogen/models/big_query_dataset_config.py +0 -114
  297. shaped/autogen/models/complement_items_request.py +0 -99
  298. shaped/autogen/models/complement_items_response.py +0 -89
  299. shaped/autogen/models/connectors_inner.py +0 -134
  300. shaped/autogen/models/create_dataset_arguments.py +0 -263
  301. shaped/autogen/models/create_embedding_response.py +0 -87
  302. shaped/autogen/models/create_item_embedding_request.py +0 -89
  303. shaped/autogen/models/create_model_arguments.py +0 -107
  304. shaped/autogen/models/create_model_response.py +0 -87
  305. shaped/autogen/models/create_user_embedding_request.py +0 -89
  306. shaped/autogen/models/custom_dataset_config.py +0 -115
  307. shaped/autogen/models/dataset_config.py +0 -101
  308. shaped/autogen/models/dataset_schema_type.py +0 -47
  309. shaped/autogen/models/datasets_inner.py +0 -91
  310. shaped/autogen/models/delete_model_response.py +0 -87
  311. shaped/autogen/models/fetch_config.py +0 -95
  312. shaped/autogen/models/file_config.py +0 -105
  313. shaped/autogen/models/file_source_config.py +0 -89
  314. shaped/autogen/models/inference_config.py +0 -101
  315. shaped/autogen/models/insert_model_response.py +0 -87
  316. shaped/autogen/models/interaction.py +0 -87
  317. shaped/autogen/models/list_datasets_response.py +0 -95
  318. shaped/autogen/models/list_models_response.py +0 -95
  319. shaped/autogen/models/model_config.py +0 -99
  320. shaped/autogen/models/model_response.py +0 -95
  321. shaped/autogen/models/mongo_db_dataset_config.py +0 -119
  322. shaped/autogen/models/post_rank_request.py +0 -117
  323. shaped/autogen/models/rank_attribute_response.py +0 -89
  324. shaped/autogen/models/rank_grid_attribute_request.py +0 -91
  325. shaped/autogen/models/rank_grid_attribute_request1.py +0 -93
  326. shaped/autogen/models/rank_grid_attribute_response.py +0 -91
  327. shaped/autogen/models/rank_response.py +0 -91
  328. shaped/autogen/models/retrieve_request.py +0 -101
  329. shaped/autogen/models/retrieve_response.py +0 -91
  330. shaped/autogen/models/retriever_top_k_override.py +0 -97
  331. shaped/autogen/models/rudder_stack_dataset_config.py +0 -96
  332. shaped/autogen/models/segment_dataset_config.py +0 -96
  333. shaped/autogen/models/similar_item_request.py +0 -101
  334. shaped/autogen/models/similar_response.py +0 -89
  335. shaped/autogen/models/similar_users_request.py +0 -99
  336. shaped/autogen/models/successful_response.py +0 -87
  337. shaped/autogen/models/view_model_response.py +0 -99
  338. shaped-2.0.1.dist-info/RECORD +0 -73
  339. shaped-2.0.1.dist-info/entry_points.txt +0 -2
  340. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/top_level.txt +0 -0
  341. {shaped-2.0.1.dist-info → shaped-2.0.4.dist-info}/zip-safe +0 -0
@@ -0,0 +1,87 @@
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.4
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, StrictStr
21
+ from typing import Any, ClassVar, Dict, List
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class SetupEngineResponse(BaseModel):
26
+ """
27
+ SetupEngineResponse
28
+ """ # noqa: E501
29
+ engine_url: StrictStr = Field(description="URL to access the created or updated engine.")
30
+ __properties: ClassVar[List[str]] = ["engine_url"]
31
+
32
+ model_config = ConfigDict(
33
+ populate_by_name=True,
34
+ validate_assignment=True,
35
+ protected_namespaces=(),
36
+ )
37
+
38
+
39
+ def to_str(self) -> str:
40
+ """Returns the string representation of the model using alias"""
41
+ return pprint.pformat(self.model_dump(by_alias=True))
42
+
43
+ def to_json(self) -> str:
44
+ """Returns the JSON representation of the model using alias"""
45
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
46
+ return json.dumps(self.to_dict())
47
+
48
+ @classmethod
49
+ def from_json(cls, json_str: str) -> Optional[Self]:
50
+ """Create an instance of SetupEngineResponse from a JSON string"""
51
+ return cls.from_dict(json.loads(json_str))
52
+
53
+ def to_dict(self) -> Dict[str, Any]:
54
+ """Return the dictionary representation of the model using alias.
55
+
56
+ This has the following differences from calling pydantic's
57
+ `self.model_dump(by_alias=True)`:
58
+
59
+ * `None` is only added to the output dict for nullable fields that
60
+ were set at model initialization. Other fields with value `None`
61
+ are ignored.
62
+ """
63
+ excluded_fields: Set[str] = set([
64
+ ])
65
+
66
+ _dict = self.model_dump(
67
+ by_alias=True,
68
+ exclude=excluded_fields,
69
+ exclude_none=True,
70
+ )
71
+ return _dict
72
+
73
+ @classmethod
74
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
75
+ """Create an instance of SetupEngineResponse from a dict"""
76
+ if obj is None:
77
+ return None
78
+
79
+ if not isinstance(obj, dict):
80
+ return cls.model_validate(obj)
81
+
82
+ _obj = cls.model_validate({
83
+ "engine_url": obj.get("engine_url")
84
+ })
85
+ return _obj
86
+
87
+
@@ -0,0 +1,154 @@
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.4
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.bm25 import Bm25
23
+ from shaped.autogen.models.factors import Factors
24
+ from shaped.autogen.models.regularization import Regularization
25
+ from typing import Optional, Set
26
+ from typing_extensions import Self
27
+
28
+ class ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig(BaseModel):
29
+ """
30
+ ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig
31
+ """ # noqa: E501
32
+ policy_type: Optional[StrictStr] = Field(default='als', description="Policy type discriminator.")
33
+ name: Optional[StrictStr] = None
34
+ event_values: Optional[List[StrictStr]] = None
35
+ factors: Optional[Factors] = None
36
+ regularization: Optional[Regularization] = None
37
+ bm25: Optional[Bm25] = None
38
+ bm25_k1: Optional[Union[StrictFloat, StrictInt]] = Field(default=1.2, description="BM25 coefficient for item frequency factor.")
39
+ bm25_b: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.75, description="BM25 coefficient for document length factor.")
40
+ use_features: Optional[StrictBool] = Field(default=False, description="Whether to use entity features in the model.")
41
+ normalize_numerical_features: Optional[StrictBool] = Field(default=False, description="Enable NormalizeNumerical transform for entity features.")
42
+ use_derived_timestamp_features: Optional[StrictBool] = Field(default=False, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
43
+ balance_labels: Optional[StrictBool] = Field(default=False, description="Enable BalanceLabel transform for interactions.")
44
+ additional_properties: Dict[str, Any] = {}
45
+ __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "factors", "regularization", "bm25", "bm25_k1", "bm25_b", "use_features", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
46
+
47
+ @field_validator('policy_type')
48
+ def policy_type_validate_enum(cls, value):
49
+ """Validates the enum"""
50
+ if value is None:
51
+ return value
52
+
53
+ if value not in set(['als']):
54
+ raise ValueError("must be one of enum values ('als')")
55
+ return value
56
+
57
+ model_config = ConfigDict(
58
+ populate_by_name=True,
59
+ validate_assignment=True,
60
+ protected_namespaces=(),
61
+ )
62
+
63
+
64
+ def to_str(self) -> str:
65
+ """Returns the string representation of the model using alias"""
66
+ return pprint.pformat(self.model_dump(by_alias=True))
67
+
68
+ def to_json(self) -> str:
69
+ """Returns the JSON representation of the model using alias"""
70
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
71
+ return json.dumps(self.to_dict())
72
+
73
+ @classmethod
74
+ def from_json(cls, json_str: str) -> Optional[Self]:
75
+ """Create an instance of ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig from a JSON string"""
76
+ return cls.from_dict(json.loads(json_str))
77
+
78
+ def to_dict(self) -> Dict[str, Any]:
79
+ """Return the dictionary representation of the model using alias.
80
+
81
+ This has the following differences from calling pydantic's
82
+ `self.model_dump(by_alias=True)`:
83
+
84
+ * `None` is only added to the output dict for nullable fields that
85
+ were set at model initialization. Other fields with value `None`
86
+ are ignored.
87
+ * Fields in `self.additional_properties` are added to the output dict.
88
+ """
89
+ excluded_fields: Set[str] = set([
90
+ "additional_properties",
91
+ ])
92
+
93
+ _dict = self.model_dump(
94
+ by_alias=True,
95
+ exclude=excluded_fields,
96
+ exclude_none=True,
97
+ )
98
+ # override the default output from pydantic by calling `to_dict()` of factors
99
+ if self.factors:
100
+ _dict['factors'] = self.factors.to_dict()
101
+ # override the default output from pydantic by calling `to_dict()` of regularization
102
+ if self.regularization:
103
+ _dict['regularization'] = self.regularization.to_dict()
104
+ # override the default output from pydantic by calling `to_dict()` of bm25
105
+ if self.bm25:
106
+ _dict['bm25'] = self.bm25.to_dict()
107
+ # puts key-value pairs in additional_properties in the top level
108
+ if self.additional_properties is not None:
109
+ for _key, _value in self.additional_properties.items():
110
+ _dict[_key] = _value
111
+
112
+ # set to None if name (nullable) is None
113
+ # and model_fields_set contains the field
114
+ if self.name is None and "name" in self.model_fields_set:
115
+ _dict['name'] = None
116
+
117
+ # set to None if event_values (nullable) is None
118
+ # and model_fields_set contains the field
119
+ if self.event_values is None and "event_values" in self.model_fields_set:
120
+ _dict['event_values'] = None
121
+
122
+ return _dict
123
+
124
+ @classmethod
125
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
126
+ """Create an instance of ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig from a dict"""
127
+ if obj is None:
128
+ return None
129
+
130
+ if not isinstance(obj, dict):
131
+ return cls.model_validate(obj)
132
+
133
+ _obj = cls.model_validate({
134
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'als',
135
+ "name": obj.get("name"),
136
+ "event_values": obj.get("event_values"),
137
+ "factors": Factors.from_dict(obj["factors"]) if obj.get("factors") is not None else None,
138
+ "regularization": Regularization.from_dict(obj["regularization"]) if obj.get("regularization") is not None else None,
139
+ "bm25": Bm25.from_dict(obj["bm25"]) if obj.get("bm25") is not None else None,
140
+ "bm25_k1": obj.get("bm25_k1") if obj.get("bm25_k1") is not None else 1.2,
141
+ "bm25_b": obj.get("bm25_b") if obj.get("bm25_b") is not None else 0.75,
142
+ "use_features": obj.get("use_features") if obj.get("use_features") is not None else False,
143
+ "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else False,
144
+ "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else False,
145
+ "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else False
146
+ })
147
+ # store additional fields in additional_properties
148
+ for _key in obj.keys():
149
+ if _key not in cls.__properties:
150
+ _obj.additional_properties[_key] = obj.get(_key)
151
+
152
+ return _obj
153
+
154
+
@@ -0,0 +1,160 @@
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.4
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, StrictInt, StrictStr, field_validator
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from shaped.autogen.models.embedder_batch_size import EmbedderBatchSize
23
+ from shaped.autogen.models.lr import Lr
24
+ from shaped.autogen.models.max_seq_length import MaxSeqLength
25
+ from typing import Optional, Set
26
+ from typing_extensions import Self
27
+
28
+ class ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig(BaseModel):
29
+ """
30
+ ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig
31
+ """ # noqa: E501
32
+ policy_type: Optional[StrictStr] = 'beeformer'
33
+ name: Optional[StrictStr] = None
34
+ event_values: Optional[List[StrictStr]] = None
35
+ device: Optional[StrictStr] = None
36
+ seed: Optional[StrictInt] = Field(default=42, description="Random seed for reproducibility.")
37
+ lr: Optional[Lr] = None
38
+ use_scheduler: Optional[StrictBool] = Field(default=False, description="Whether to use a learning rate scheduler.")
39
+ epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
40
+ max_output: Optional[StrictInt] = Field(default=1, description="Negative sampling hyperparameter, uniform.")
41
+ batch_size: Optional[StrictInt] = Field(default=1024, description="Number of samples processed before updating model weights.")
42
+ top_k: Optional[StrictInt] = Field(default=0, description="Optimize only for top-k predictions on the output.")
43
+ embedder: Optional[StrictStr] = 'all-mpnet-base-v2'
44
+ use_images: Optional[StrictBool] = Field(default=False, description="Use image features.")
45
+ max_seq_length: Optional[MaxSeqLength] = None
46
+ embedder_batch_size: Optional[EmbedderBatchSize] = None
47
+ train_distributed: Optional[StrictBool] = Field(default=False, description="Train on multiple devices.")
48
+ normalize_numerical_features: Optional[StrictBool] = Field(default=False, description="Enable NormalizeNumerical transform for entity features.")
49
+ use_derived_timestamp_features: Optional[StrictBool] = Field(default=False, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
50
+ balance_labels: Optional[StrictBool] = Field(default=False, description="Enable BalanceLabel transform for interactions.")
51
+ __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "device", "seed", "lr", "use_scheduler", "epochs", "max_output", "batch_size", "top_k", "embedder", "use_images", "max_seq_length", "embedder_batch_size", "train_distributed", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
52
+
53
+ @field_validator('policy_type')
54
+ def policy_type_validate_enum(cls, value):
55
+ """Validates the enum"""
56
+ if value is None:
57
+ return value
58
+
59
+ if value not in set(['beeformer']):
60
+ raise ValueError("must be one of enum values ('beeformer')")
61
+ return value
62
+
63
+ model_config = ConfigDict(
64
+ populate_by_name=True,
65
+ validate_assignment=True,
66
+ protected_namespaces=(),
67
+ )
68
+
69
+
70
+ def to_str(self) -> str:
71
+ """Returns the string representation of the model using alias"""
72
+ return pprint.pformat(self.model_dump(by_alias=True))
73
+
74
+ def to_json(self) -> str:
75
+ """Returns the JSON representation of the model using alias"""
76
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
77
+ return json.dumps(self.to_dict())
78
+
79
+ @classmethod
80
+ def from_json(cls, json_str: str) -> Optional[Self]:
81
+ """Create an instance of ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig from a JSON string"""
82
+ return cls.from_dict(json.loads(json_str))
83
+
84
+ def to_dict(self) -> Dict[str, Any]:
85
+ """Return the dictionary representation of the model using alias.
86
+
87
+ This has the following differences from calling pydantic's
88
+ `self.model_dump(by_alias=True)`:
89
+
90
+ * `None` is only added to the output dict for nullable fields that
91
+ were set at model initialization. Other fields with value `None`
92
+ are ignored.
93
+ """
94
+ excluded_fields: Set[str] = set([
95
+ ])
96
+
97
+ _dict = self.model_dump(
98
+ by_alias=True,
99
+ exclude=excluded_fields,
100
+ exclude_none=True,
101
+ )
102
+ # override the default output from pydantic by calling `to_dict()` of lr
103
+ if self.lr:
104
+ _dict['lr'] = self.lr.to_dict()
105
+ # override the default output from pydantic by calling `to_dict()` of max_seq_length
106
+ if self.max_seq_length:
107
+ _dict['max_seq_length'] = self.max_seq_length.to_dict()
108
+ # override the default output from pydantic by calling `to_dict()` of embedder_batch_size
109
+ if self.embedder_batch_size:
110
+ _dict['embedder_batch_size'] = self.embedder_batch_size.to_dict()
111
+ # set to None if name (nullable) is None
112
+ # and model_fields_set contains the field
113
+ if self.name is None and "name" in self.model_fields_set:
114
+ _dict['name'] = None
115
+
116
+ # set to None if event_values (nullable) is None
117
+ # and model_fields_set contains the field
118
+ if self.event_values is None and "event_values" in self.model_fields_set:
119
+ _dict['event_values'] = None
120
+
121
+ # set to None if device (nullable) is None
122
+ # and model_fields_set contains the field
123
+ if self.device is None and "device" in self.model_fields_set:
124
+ _dict['device'] = None
125
+
126
+ return _dict
127
+
128
+ @classmethod
129
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
130
+ """Create an instance of ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig from a dict"""
131
+ if obj is None:
132
+ return None
133
+
134
+ if not isinstance(obj, dict):
135
+ return cls.model_validate(obj)
136
+
137
+ _obj = cls.model_validate({
138
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'beeformer',
139
+ "name": obj.get("name"),
140
+ "event_values": obj.get("event_values"),
141
+ "device": obj.get("device"),
142
+ "seed": obj.get("seed") if obj.get("seed") is not None else 42,
143
+ "lr": Lr.from_dict(obj["lr"]) if obj.get("lr") is not None else None,
144
+ "use_scheduler": obj.get("use_scheduler") if obj.get("use_scheduler") is not None else False,
145
+ "epochs": obj.get("epochs") if obj.get("epochs") is not None else 1,
146
+ "max_output": obj.get("max_output") if obj.get("max_output") is not None else 1,
147
+ "batch_size": obj.get("batch_size") if obj.get("batch_size") is not None else 1024,
148
+ "top_k": obj.get("top_k") if obj.get("top_k") is not None else 0,
149
+ "embedder": obj.get("embedder") if obj.get("embedder") is not None else 'all-mpnet-base-v2',
150
+ "use_images": obj.get("use_images") if obj.get("use_images") is not None else False,
151
+ "max_seq_length": MaxSeqLength.from_dict(obj["max_seq_length"]) if obj.get("max_seq_length") is not None else None,
152
+ "embedder_batch_size": EmbedderBatchSize.from_dict(obj["embedder_batch_size"]) if obj.get("embedder_batch_size") is not None else None,
153
+ "train_distributed": obj.get("train_distributed") if obj.get("train_distributed") is not None else False,
154
+ "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else False,
155
+ "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else False,
156
+ "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else False
157
+ })
158
+ return _obj
159
+
160
+
@@ -0,0 +1,215 @@
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.4
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_size import HiddenSize
26
+ from shaped.autogen.models.inner_size import InnerSize
27
+ from shaped.autogen.models.learning_rate import LearningRate
28
+ from shaped.autogen.models.loss_types import LossTypes
29
+ from shaped.autogen.models.max_seq_length1 import MaxSeqLength1
30
+ from shaped.autogen.models.n_epochs import NEpochs
31
+ from shaped.autogen.models.n_heads import NHeads
32
+ from shaped.autogen.models.n_layers import NLayers
33
+ from shaped.autogen.models.sampling_strategy import SamplingStrategy
34
+ from typing import Optional, Set
35
+ from typing_extensions import Self
36
+
37
+ class ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig(BaseModel):
38
+ """
39
+ ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig
40
+ """ # noqa: E501
41
+ policy_type: Optional[StrictStr] = 'bert4rec'
42
+ name: Optional[StrictStr] = None
43
+ event_values: Optional[List[StrictStr]] = None
44
+ batch_size: Optional[BatchSize] = None
45
+ eval_batch_size: Optional[StrictInt] = Field(default=1000, description="Batch size used during model evaluation.")
46
+ n_epochs: Optional[NEpochs] = None
47
+ negative_samples_count: Optional[StrictInt] = Field(default=2, description="Number of negative samples per positive sample for contrastive learning.")
48
+ device: Optional[StrictStr] = None
49
+ hidden_size: Optional[HiddenSize] = None
50
+ inner_size: Optional[InnerSize] = None
51
+ learning_rate: Optional[LearningRate] = None
52
+ attn_dropout_prob: Optional[AttnDropoutProb] = None
53
+ hidden_act: Optional[StrictStr] = 'gelu'
54
+ hidden_dropout_prob: Optional[HiddenDropoutProb] = None
55
+ n_heads: Optional[NHeads] = None
56
+ n_layers: Optional[NLayers] = None
57
+ layer_norm_eps: Optional[Union[StrictFloat, StrictInt]] = 1.0E-12
58
+ initializer_range: Optional[Union[StrictFloat, StrictInt]] = 0.02
59
+ mask_rate: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.2, description="Fraction of tokens to mask during training.")
60
+ loss_type: Optional[LossTypes] = None
61
+ max_seq_length: Optional[MaxSeqLength1] = None
62
+ sample_strategy: Optional[SamplingStrategy] = None
63
+ sample_seed: Optional[StrictInt] = 42
64
+ sample_ratio: Optional[Union[StrictFloat, StrictInt]] = 0.8
65
+ eval_step: Optional[StrictInt] = 1
66
+ early_stopping_step: Optional[StrictInt] = 5
67
+ normalize_numerical_features: Optional[StrictBool] = Field(default=True, description="Enable NormalizeNumerical transform for entity features.")
68
+ use_derived_timestamp_features: Optional[StrictBool] = Field(default=True, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
69
+ balance_labels: Optional[StrictBool] = Field(default=True, description="Enable BalanceLabel transform for interactions.")
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", "sample_seed", "sample_ratio", "eval_step", "early_stopping_step", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
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(['bert4rec']):
79
+ raise ValueError("must be one of enum values ('bert4rec')")
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 ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig 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
+ """
113
+ excluded_fields: Set[str] = set([
114
+ ])
115
+
116
+ _dict = self.model_dump(
117
+ by_alias=True,
118
+ exclude=excluded_fields,
119
+ exclude_none=True,
120
+ )
121
+ # override the default output from pydantic by calling `to_dict()` of batch_size
122
+ if self.batch_size:
123
+ _dict['batch_size'] = self.batch_size.to_dict()
124
+ # override the default output from pydantic by calling `to_dict()` of n_epochs
125
+ if self.n_epochs:
126
+ _dict['n_epochs'] = self.n_epochs.to_dict()
127
+ # override the default output from pydantic by calling `to_dict()` of hidden_size
128
+ if self.hidden_size:
129
+ _dict['hidden_size'] = self.hidden_size.to_dict()
130
+ # override the default output from pydantic by calling `to_dict()` of inner_size
131
+ if self.inner_size:
132
+ _dict['inner_size'] = self.inner_size.to_dict()
133
+ # override the default output from pydantic by calling `to_dict()` of learning_rate
134
+ if self.learning_rate:
135
+ _dict['learning_rate'] = self.learning_rate.to_dict()
136
+ # override the default output from pydantic by calling `to_dict()` of attn_dropout_prob
137
+ if self.attn_dropout_prob:
138
+ _dict['attn_dropout_prob'] = self.attn_dropout_prob.to_dict()
139
+ # override the default output from pydantic by calling `to_dict()` of hidden_dropout_prob
140
+ if self.hidden_dropout_prob:
141
+ _dict['hidden_dropout_prob'] = self.hidden_dropout_prob.to_dict()
142
+ # override the default output from pydantic by calling `to_dict()` of n_heads
143
+ if self.n_heads:
144
+ _dict['n_heads'] = self.n_heads.to_dict()
145
+ # override the default output from pydantic by calling `to_dict()` of n_layers
146
+ if self.n_layers:
147
+ _dict['n_layers'] = self.n_layers.to_dict()
148
+ # override the default output from pydantic by calling `to_dict()` of max_seq_length
149
+ if self.max_seq_length:
150
+ _dict['max_seq_length'] = self.max_seq_length.to_dict()
151
+ # set to None if name (nullable) is None
152
+ # and model_fields_set contains the field
153
+ if self.name is None and "name" in self.model_fields_set:
154
+ _dict['name'] = None
155
+
156
+ # set to None if event_values (nullable) is None
157
+ # and model_fields_set contains the field
158
+ if self.event_values is None and "event_values" in self.model_fields_set:
159
+ _dict['event_values'] = None
160
+
161
+ # set to None if device (nullable) is None
162
+ # and model_fields_set contains the field
163
+ if self.device is None and "device" in self.model_fields_set:
164
+ _dict['device'] = None
165
+
166
+ # set to None if sample_strategy (nullable) is None
167
+ # and model_fields_set contains the field
168
+ if self.sample_strategy is None and "sample_strategy" in self.model_fields_set:
169
+ _dict['sample_strategy'] = None
170
+
171
+ return _dict
172
+
173
+ @classmethod
174
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
175
+ """Create an instance of ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig from a dict"""
176
+ if obj is None:
177
+ return None
178
+
179
+ if not isinstance(obj, dict):
180
+ return cls.model_validate(obj)
181
+
182
+ _obj = cls.model_validate({
183
+ "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'bert4rec',
184
+ "name": obj.get("name"),
185
+ "event_values": obj.get("event_values"),
186
+ "batch_size": BatchSize.from_dict(obj["batch_size"]) if obj.get("batch_size") is not None else None,
187
+ "eval_batch_size": obj.get("eval_batch_size") if obj.get("eval_batch_size") is not None else 1000,
188
+ "n_epochs": NEpochs.from_dict(obj["n_epochs"]) if obj.get("n_epochs") is not None else None,
189
+ "negative_samples_count": obj.get("negative_samples_count") if obj.get("negative_samples_count") is not None else 2,
190
+ "device": obj.get("device"),
191
+ "hidden_size": HiddenSize.from_dict(obj["hidden_size"]) if obj.get("hidden_size") is not None else None,
192
+ "inner_size": InnerSize.from_dict(obj["inner_size"]) if obj.get("inner_size") is not None else None,
193
+ "learning_rate": LearningRate.from_dict(obj["learning_rate"]) if obj.get("learning_rate") is not None else None,
194
+ "attn_dropout_prob": AttnDropoutProb.from_dict(obj["attn_dropout_prob"]) if obj.get("attn_dropout_prob") is not None else None,
195
+ "hidden_act": obj.get("hidden_act") if obj.get("hidden_act") is not None else 'gelu',
196
+ "hidden_dropout_prob": HiddenDropoutProb.from_dict(obj["hidden_dropout_prob"]) if obj.get("hidden_dropout_prob") is not None else None,
197
+ "n_heads": NHeads.from_dict(obj["n_heads"]) if obj.get("n_heads") is not None else None,
198
+ "n_layers": NLayers.from_dict(obj["n_layers"]) if obj.get("n_layers") is not None else None,
199
+ "layer_norm_eps": obj.get("layer_norm_eps") if obj.get("layer_norm_eps") is not None else 1.0E-12,
200
+ "initializer_range": obj.get("initializer_range") if obj.get("initializer_range") is not None else 0.02,
201
+ "mask_rate": obj.get("mask_rate") if obj.get("mask_rate") is not None else 0.2,
202
+ "loss_type": obj.get("loss_type"),
203
+ "max_seq_length": MaxSeqLength1.from_dict(obj["max_seq_length"]) if obj.get("max_seq_length") is not None else None,
204
+ "sample_strategy": obj.get("sample_strategy"),
205
+ "sample_seed": obj.get("sample_seed") if obj.get("sample_seed") is not None else 42,
206
+ "sample_ratio": obj.get("sample_ratio") if obj.get("sample_ratio") is not None else 0.8,
207
+ "eval_step": obj.get("eval_step") if obj.get("eval_step") is not None else 1,
208
+ "early_stopping_step": obj.get("early_stopping_step") if obj.get("early_stopping_step") is not None else 5,
209
+ "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else True,
210
+ "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else True,
211
+ "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else True
212
+ })
213
+ return _obj
214
+
215
+