shaped 2.0.2__py3-none-any.whl → 2.0.5__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 (283) hide show
  1. shaped/__init__.py +47 -42
  2. shaped/autogen/__init__.py +41 -56
  3. shaped/autogen/api/engine_api.py +5 -6
  4. shaped/autogen/api/query_api.py +12 -73
  5. shaped/autogen/api/table_api.py +5 -6
  6. shaped/autogen/api/view_api.py +5 -6
  7. shaped/autogen/api_client.py +8 -9
  8. shaped/autogen/configuration.py +9 -8
  9. shaped/autogen/exceptions.py +11 -9
  10. shaped/autogen/models/__init__.py +23 -31
  11. shaped/autogen/models/ai_enrichment_view_config.py +5 -6
  12. shaped/autogen/models/algorithm.py +5 -6
  13. shaped/autogen/models/amplitude_table_config.py +5 -6
  14. shaped/autogen/models/attn_dropout_prob.py +5 -6
  15. shaped/autogen/models/attribute_journey.py +5 -6
  16. shaped/autogen/models/attribute_value.py +5 -6
  17. shaped/autogen/models/autoscaling_config.py +5 -6
  18. shaped/autogen/models/aws_pinpoint_table_config.py +5 -6
  19. shaped/autogen/models/batch_size.py +5 -6
  20. shaped/autogen/models/batch_size1.py +5 -6
  21. shaped/autogen/models/batch_size2.py +5 -6
  22. shaped/autogen/models/big_query_table_config.py +5 -6
  23. shaped/autogen/models/bm25.py +5 -6
  24. shaped/autogen/models/boosted_reorder_step.py +5 -6
  25. shaped/autogen/models/canary_rollout.py +5 -6
  26. shaped/autogen/models/candidate_attributes_retrieve_step.py +5 -19
  27. shaped/autogen/models/candidate_ids_retrieve_step.py +5 -6
  28. shaped/autogen/models/candidate_retrieval_strategy.py +5 -6
  29. shaped/autogen/models/clickhouse_table_config.py +5 -6
  30. shaped/autogen/models/column_order_retrieve_step.py +5 -6
  31. shaped/autogen/models/column_ordering.py +5 -6
  32. shaped/autogen/models/create_table_response.py +5 -6
  33. shaped/autogen/models/create_view_response.py +5 -6
  34. shaped/autogen/models/custom_table_config.py +5 -6
  35. shaped/autogen/models/data_compute_config.py +5 -6
  36. shaped/autogen/models/data_config.py +5 -6
  37. shaped/autogen/models/data_config_interaction_table.py +5 -6
  38. shaped/autogen/models/data_split_config.py +5 -6
  39. shaped/autogen/models/data_split_strategy.py +5 -6
  40. shaped/autogen/models/data_tier.py +5 -6
  41. shaped/autogen/models/default.py +5 -6
  42. shaped/autogen/models/delete_engine_response.py +5 -6
  43. shaped/autogen/models/delete_table_response.py +5 -6
  44. shaped/autogen/models/delete_view_response.py +5 -6
  45. shaped/autogen/models/deployment_config.py +6 -13
  46. shaped/autogen/models/diversity_reorder_step.py +5 -6
  47. shaped/autogen/models/dropout_rate.py +5 -6
  48. shaped/autogen/models/dynamo_db_table_config.py +5 -6
  49. shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +5 -6
  50. shaped/autogen/models/embedder_batch_size.py +5 -6
  51. shaped/autogen/models/embedding_config.py +5 -6
  52. shaped/autogen/models/embedding_dim.py +5 -6
  53. shaped/autogen/models/embedding_dims.py +5 -6
  54. shaped/autogen/models/embedding_size.py +5 -6
  55. shaped/autogen/models/encoder.py +5 -6
  56. shaped/autogen/models/engine.py +5 -6
  57. shaped/autogen/models/engine_config_v2.py +5 -6
  58. shaped/autogen/models/engine_details_response.py +5 -6
  59. shaped/autogen/models/engine_schema.py +12 -13
  60. shaped/autogen/models/entity_config.py +5 -6
  61. shaped/autogen/models/entity_journey.py +32 -24
  62. shaped/autogen/models/entity_type.py +5 -6
  63. shaped/autogen/models/evaluation_config.py +5 -6
  64. shaped/autogen/models/exploration_reorder_step.py +5 -6
  65. shaped/autogen/models/expression_filter_step.py +5 -6
  66. shaped/autogen/models/factors.py +5 -6
  67. shaped/autogen/models/factors1.py +5 -6
  68. shaped/autogen/models/feature.py +5 -6
  69. shaped/autogen/models/feature_type.py +5 -6
  70. shaped/autogen/models/file_table_config.py +5 -6
  71. shaped/autogen/models/filter_config.py +18 -19
  72. shaped/autogen/models/filter_index_type.py +5 -6
  73. shaped/autogen/models/filter_retrieve_step.py +5 -6
  74. shaped/autogen/models/filter_step_explanation.py +164 -0
  75. shaped/autogen/models/{filter_dataset.py → filter_table.py} +12 -13
  76. shaped/autogen/models/{type.py → filter_type.py} +10 -11
  77. shaped/autogen/models/global_filter.py +5 -6
  78. shaped/autogen/models/hidden_dropout_prob.py +5 -6
  79. shaped/autogen/models/hidden_size.py +5 -6
  80. shaped/autogen/models/hidden_size1.py +5 -6
  81. shaped/autogen/models/http_problem_response.py +5 -6
  82. shaped/autogen/models/http_validation_error.py +5 -6
  83. shaped/autogen/models/hugging_face_encoder.py +10 -9
  84. shaped/autogen/models/iceberg_table_config.py +5 -6
  85. shaped/autogen/models/index_config.py +5 -6
  86. shaped/autogen/models/{time_window_in_days.py → inner_entity_id.py} +27 -26
  87. shaped/autogen/models/inner_size.py +5 -6
  88. shaped/autogen/models/inner_size1.py +5 -6
  89. shaped/autogen/models/{mode2.py → inner_uid.py} +37 -30
  90. shaped/autogen/models/interaction_config.py +5 -6
  91. shaped/autogen/models/interaction_pooling_encoder.py +5 -6
  92. shaped/autogen/models/interaction_round_robin_encoder.py +5 -6
  93. shaped/autogen/models/item_attribute_pooling_encoder.py +5 -19
  94. shaped/autogen/models/journey.py +5 -6
  95. shaped/autogen/models/kafka_table_config.py +5 -6
  96. shaped/autogen/models/kinesis_table_config.py +5 -6
  97. shaped/autogen/models/kinesis_table_config_column_schema_value.py +5 -6
  98. shaped/autogen/models/label.py +5 -6
  99. shaped/autogen/models/label_type.py +5 -7
  100. shaped/autogen/models/laplace_smoothing.py +5 -6
  101. shaped/autogen/models/latency_scaling_policy.py +5 -6
  102. shaped/autogen/models/learning_rate.py +5 -6
  103. shaped/autogen/models/learning_rate1.py +5 -6
  104. shaped/autogen/models/learning_rate2.py +5 -6
  105. shaped/autogen/models/learning_rate3.py +5 -6
  106. shaped/autogen/models/lexical_search_mode.py +7 -8
  107. shaped/autogen/models/list_engines_response.py +5 -6
  108. shaped/autogen/models/list_tables_response.py +5 -6
  109. shaped/autogen/models/list_views_response.py +5 -6
  110. shaped/autogen/models/{validation_error_loc_inner.py → location_inner.py} +11 -12
  111. shaped/autogen/models/loss_types.py +5 -6
  112. shaped/autogen/models/lr.py +5 -6
  113. shaped/autogen/models/lr1.py +5 -6
  114. shaped/autogen/models/lr2.py +5 -6
  115. shaped/autogen/models/max_depth.py +5 -6
  116. shaped/autogen/models/max_leaves.py +5 -6
  117. shaped/autogen/models/max_seq_length.py +5 -6
  118. shaped/autogen/models/max_seq_length1.py +5 -6
  119. shaped/autogen/models/max_seq_length2.py +5 -6
  120. shaped/autogen/models/mode.py +5 -6
  121. shaped/autogen/models/mode1.py +24 -23
  122. shaped/autogen/models/{training_config_models_inner.py → models_inner.py} +13 -14
  123. shaped/autogen/models/mongo_db_table_config.py +5 -6
  124. shaped/autogen/models/mssql_table_config.py +5 -6
  125. shaped/autogen/models/my_sql_table_config.py +5 -6
  126. shaped/autogen/models/n_epochs.py +5 -6
  127. shaped/autogen/models/n_epochs1.py +5 -6
  128. shaped/autogen/models/n_epochs2.py +5 -6
  129. shaped/autogen/models/n_estimators.py +5 -6
  130. shaped/autogen/models/n_heads.py +5 -6
  131. shaped/autogen/models/n_layers.py +5 -6
  132. shaped/autogen/models/neg_per_positive.py +5 -6
  133. shaped/autogen/models/negative_samples_count.py +5 -6
  134. shaped/autogen/models/ngram_tokenizer.py +5 -6
  135. shaped/autogen/models/no_op_config.py +5 -6
  136. shaped/autogen/models/num_blocks.py +5 -6
  137. shaped/autogen/models/num_heads.py +5 -6
  138. shaped/autogen/models/num_leaves.py +5 -6
  139. shaped/autogen/models/objective.py +5 -6
  140. shaped/autogen/models/objective1.py +5 -6
  141. shaped/autogen/models/online_store_config.py +5 -6
  142. shaped/autogen/models/pagination_config.py +5 -6
  143. shaped/autogen/models/parameter_definition.py +5 -6
  144. shaped/autogen/models/parameters_value.py +5 -6
  145. shaped/autogen/models/passthrough_score.py +5 -6
  146. shaped/autogen/models/personal_filter.py +5 -6
  147. shaped/autogen/models/pipeline_stage_explanation.py +8 -9
  148. shaped/autogen/models/policy.py +5 -6
  149. shaped/autogen/models/pooling_function.py +5 -6
  150. shaped/autogen/models/postgres_table_config.py +5 -6
  151. shaped/autogen/models/posthog_table_config.py +5 -6
  152. shaped/autogen/models/prebuilt_filter_step.py +5 -6
  153. shaped/autogen/models/precomputed_item_embedding.py +5 -6
  154. shaped/autogen/models/precomputed_user_embedding.py +5 -6
  155. shaped/autogen/models/query.py +19 -20
  156. shaped/autogen/models/query1.py +19 -20
  157. shaped/autogen/models/{query_any_of.py → query_config.py} +13 -14
  158. shaped/autogen/models/query_definition.py +5 -6
  159. shaped/autogen/models/query_encoder.py +5 -6
  160. shaped/autogen/models/query_explanation.py +11 -8
  161. shaped/autogen/models/query_request.py +5 -6
  162. shaped/autogen/models/query_result.py +5 -6
  163. shaped/autogen/models/query_table_config.py +5 -6
  164. shaped/autogen/models/rank_item_attribute_values_query_config.py +5 -6
  165. shaped/autogen/models/rank_query_config.py +11 -12
  166. shaped/autogen/models/rank_query_config_filter_inner.py +5 -6
  167. shaped/autogen/models/recreate_rollout.py +5 -6
  168. shaped/autogen/models/redshift_table_config.py +5 -6
  169. shaped/autogen/models/reference_table_config.py +5 -6
  170. shaped/autogen/models/regularization.py +5 -6
  171. shaped/autogen/models/{rank_query_config_reorder_inner.py → reorder_inner.py} +11 -12
  172. shaped/autogen/models/reorder_step_explanation.py +206 -0
  173. shaped/autogen/models/request.py +5 -6
  174. shaped/autogen/models/request1.py +5 -6
  175. shaped/autogen/models/requests_per_second_scaling_policy.py +5 -6
  176. shaped/autogen/models/resource_config.py +99 -0
  177. shaped/autogen/models/response_get_view_details_views_view_name_get.py +5 -6
  178. shaped/autogen/models/result.py +5 -19
  179. shaped/autogen/models/result_embeddings_value.py +5 -6
  180. shaped/autogen/models/{ascending.py → retrieval_scores_value.py} +26 -36
  181. shaped/autogen/models/{rank_query_config_retrieve_inner.py → retrieve_inner.py} +13 -14
  182. shaped/autogen/models/retrieve_step_explanation.py +171 -0
  183. shaped/autogen/models/retriever.py +5 -6
  184. shaped/autogen/models/retriever1.py +5 -6
  185. shaped/autogen/models/rollout_config.py +5 -6
  186. shaped/autogen/models/rudderstack_table_config.py +5 -6
  187. shaped/autogen/models/sampling_strategy.py +5 -6
  188. shaped/autogen/models/saved_query_info_response.py +22 -9
  189. shaped/autogen/models/saved_query_list_response.py +5 -6
  190. shaped/autogen/models/saved_query_request.py +5 -6
  191. shaped/autogen/models/schema_config.py +5 -6
  192. shaped/autogen/models/score.py +5 -6
  193. shaped/autogen/models/score_ensemble.py +5 -19
  194. shaped/autogen/models/score_step_explanation.py +223 -0
  195. shaped/autogen/models/search_config.py +5 -6
  196. shaped/autogen/models/segment_table_config.py +5 -6
  197. shaped/autogen/models/sequence_length.py +5 -6
  198. shaped/autogen/models/server_config.py +18 -6
  199. shaped/autogen/models/setup_engine_response.py +5 -6
  200. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +13 -8
  201. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +13 -8
  202. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +14 -9
  203. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +10 -9
  204. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +13 -8
  205. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +5 -6
  206. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +13 -8
  207. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +5 -6
  208. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +5 -6
  209. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +13 -8
  210. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +5 -6
  211. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +13 -8
  212. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +14 -9
  213. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +16 -11
  214. shaped/autogen/models/shopify_table_config.py +5 -6
  215. shaped/autogen/models/similarity_retrieve_step.py +10 -9
  216. shaped/autogen/models/snowflake_table_config.py +5 -6
  217. shaped/autogen/models/sql_transform_type.py +5 -6
  218. shaped/autogen/models/sql_view_config.py +5 -6
  219. shaped/autogen/models/stemmer_tokenizer.py +5 -6
  220. shaped/autogen/models/step_explanation.py +5 -6
  221. shaped/autogen/models/steps_inner.py +178 -0
  222. shaped/autogen/models/strategy.py +5 -6
  223. shaped/autogen/models/table.py +5 -6
  224. shaped/autogen/models/table_deployment_type.py +5 -6
  225. shaped/autogen/models/table_insert_arguments.py +7 -8
  226. shaped/autogen/models/table_insert_response.py +5 -6
  227. shaped/autogen/models/text_search_retrieve_step.py +5 -6
  228. shaped/autogen/models/time_frequency.py +5 -6
  229. shaped/autogen/models/time_window.py +5 -6
  230. shaped/autogen/models/tokenizer.py +5 -6
  231. shaped/autogen/models/trained_model_encoder.py +5 -6
  232. shaped/autogen/models/training_compute_config.py +8 -9
  233. shaped/autogen/models/training_config.py +8 -9
  234. shaped/autogen/models/training_strategy.py +5 -6
  235. shaped/autogen/models/transform_status.py +40 -0
  236. shaped/autogen/models/truncate_filter_step.py +5 -6
  237. shaped/autogen/models/tunable_bool.py +5 -6
  238. shaped/autogen/models/tunable_float.py +5 -6
  239. shaped/autogen/models/tunable_int.py +5 -6
  240. shaped/autogen/models/tunable_int_categorical.py +5 -6
  241. shaped/autogen/models/tunable_string.py +5 -6
  242. shaped/autogen/models/tuning_config.py +5 -6
  243. shaped/autogen/models/update_table_response.py +5 -6
  244. shaped/autogen/models/update_view_response.py +5 -6
  245. shaped/autogen/models/user_attribute_pooling_encoder.py +5 -6
  246. shaped/autogen/models/{engine_schema_user_inner.py → user_inner.py} +11 -12
  247. shaped/autogen/models/val_split.py +5 -6
  248. shaped/autogen/models/validation_error.py +8 -9
  249. shaped/autogen/models/value_type.py +5 -6
  250. shaped/autogen/models/vector_search_mode.py +10 -9
  251. shaped/autogen/models/view.py +8 -9
  252. shaped/autogen/models/view_details_ai.py +10 -11
  253. shaped/autogen/models/view_details_ai_schema_value.py +5 -6
  254. shaped/autogen/models/view_details_sql.py +10 -11
  255. shaped/autogen/models/weight_decay.py +5 -6
  256. shaped/autogen/models/whitespace_tokenizer.py +5 -6
  257. shaped/autogen/models/window_size.py +5 -6
  258. shaped/autogen/rest.py +13 -14
  259. shaped/cli/shaped_cli.py +152 -29
  260. shaped/client.py +50 -43
  261. shaped/config_builders.py +110 -100
  262. shaped/query_builder.py +56 -49
  263. {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/METADATA +2 -2
  264. shaped-2.0.5.dist-info/RECORD +271 -0
  265. {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/WHEEL +1 -1
  266. shaped/autogen/models/distance_function.py +0 -38
  267. shaped/autogen/models/encoding_pooling_strategy.py +0 -38
  268. shaped/autogen/models/pool_fn.py +0 -134
  269. shaped/autogen/models/score_ensemble_policy_config.py +0 -141
  270. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +0 -422
  271. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +0 -137
  272. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +0 -152
  273. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +0 -137
  274. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +0 -104
  275. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +0 -130
  276. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +0 -131
  277. shaped/autogen/models/text_encoding.py +0 -136
  278. shaped/autogen/models/trending_mode.py +0 -37
  279. shaped/autogen/models/view_status.py +0 -41
  280. shaped-2.0.2.dist-info/RECORD +0 -278
  281. {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/entry_points.txt +0 -0
  282. {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/top_level.txt +0 -0
  283. {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/zip-safe +0 -0
shaped/__init__.py CHANGED
@@ -1,54 +1,59 @@
1
1
  """
2
- Shaped V2 SDK for Python.
2
+ Shaped Python SDK public API.
3
3
 
4
- Provides client SDK for interacting with Shaped AI V2 API.
4
+ This module re-exports the primary user-facing symbols so users can write:
5
+
6
+ from shaped import Client, Engine, Table, View
7
+ from shaped import RankQueryBuilder, Similarity, ColumnOrder
8
+
9
+ Keep this file lightweight and stable: it is part of the SDK's public surface.
5
10
  """
6
- from shaped.client import Client
11
+
12
+ from __future__ import annotations
13
+
14
+ from shaped.client import Client, ViewConfig
15
+ from shaped.config_builders import Engine, Table, View
7
16
  from shaped.query_builder import (
8
- RankQueryBuilder,
9
- ColumnOrder,
10
- TextSearch,
11
- Similarity,
12
- CandidateIds,
17
+ Boosted,
13
18
  CandidateAttributes,
14
- Filter,
19
+ CandidateIds,
20
+ ColumnOrder,
21
+ Diversity,
22
+ Exploration,
15
23
  Expression,
16
- Truncate,
24
+ Filter,
25
+ Passthrough,
17
26
  Prebuilt,
18
- ensemble as Ensemble,
19
- Boosted,
20
- Exploration,
21
- Diversity,
22
- )
23
- from shaped.config_builders import (
24
- Engine,
25
- Table,
26
- View,
27
+ RankQueryBuilder,
28
+ Similarity,
29
+ TextSearch,
30
+ Truncate,
31
+ ensemble,
27
32
  )
28
33
 
29
- # Type alias for ViewConfig
30
- # Type alias for ViewConfig
31
- from shaped.client import ViewConfig
34
+ # Backwards-compatible alias.
35
+ Ensemble = ensemble
32
36
 
33
37
  __all__ = [
34
- 'Client',
35
- 'RankQueryBuilder',
36
- 'Similarity',
37
- 'TextSearch',
38
- 'CandidateIds',
39
- 'CandidateAttributes',
40
- 'ColumnOrder',
41
- 'Filter',
42
- 'Expression',
43
- 'Truncate',
44
- 'Prebuilt',
45
- 'Ensemble',
46
- 'Passthrough',
47
- 'Diversity',
48
- 'Boosted',
49
- 'Exploration',
50
- 'ViewConfig',
51
- 'Engine',
52
- 'Table',
53
- 'View',
38
+ "Boosted",
39
+ "CandidateAttributes",
40
+ "CandidateIds",
41
+ "Client",
42
+ "ColumnOrder",
43
+ "Diversity",
44
+ "Ensemble",
45
+ "Engine",
46
+ "Exploration",
47
+ "Expression",
48
+ "Filter",
49
+ "Passthrough",
50
+ "Prebuilt",
51
+ "RankQueryBuilder",
52
+ "Similarity",
53
+ "Table",
54
+ "TextSearch",
55
+ "Truncate",
56
+ "View",
57
+ "ViewConfig",
58
+ "ensemble",
54
59
  ]
@@ -3,15 +3,14 @@
3
3
  # flake8: noqa
4
4
 
5
5
  """
6
- Shaped API
6
+ Shaped API
7
7
 
8
- 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`
8
+ 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`
9
9
 
10
- The version of the OpenAPI document: 2.0.0
11
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
12
11
 
13
- Do not edit the class manually.
14
- """ # noqa: E501
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
15
14
 
16
15
 
17
16
  __version__ = "1.0.0"
@@ -35,7 +34,6 @@ __all__ = [
35
34
  "AWSPinpointTableConfig",
36
35
  "Algorithm",
37
36
  "AmplitudeTableConfig",
38
- "Ascending",
39
37
  "AttnDropoutProb",
40
38
  "AttributeJourney",
41
39
  "AttributeValue",
@@ -67,7 +65,6 @@ __all__ = [
67
65
  "DeleteTableResponse",
68
66
  "DeleteViewResponse",
69
67
  "DeploymentConfig",
70
- "DistanceFunction",
71
68
  "DiversityReorderStep",
72
69
  "DropoutRate",
73
70
  "DynamoDBTableConfig",
@@ -78,12 +75,10 @@ __all__ = [
78
75
  "EmbeddingDims",
79
76
  "EmbeddingSize",
80
77
  "Encoder",
81
- "EncodingPoolingStrategy",
82
78
  "Engine",
83
79
  "EngineConfigV2",
84
80
  "EngineDetailsResponse",
85
81
  "EngineSchema",
86
- "EngineSchemaUserInner",
87
82
  "EntityConfig",
88
83
  "EntityJourney",
89
84
  "EntityType",
@@ -96,9 +91,11 @@ __all__ = [
96
91
  "FeatureType",
97
92
  "FileTableConfig",
98
93
  "FilterConfig",
99
- "FilterDataset",
100
94
  "FilterIndexType",
101
95
  "FilterRetrieveStep",
96
+ "FilterStepExplanation",
97
+ "FilterTable",
98
+ "FilterType",
102
99
  "GlobalFilter",
103
100
  "HTTPValidationError",
104
101
  "HiddenDropoutProb",
@@ -108,8 +105,10 @@ __all__ = [
108
105
  "HuggingFaceEncoder",
109
106
  "IcebergTableConfig",
110
107
  "IndexConfig",
108
+ "InnerEntityId",
111
109
  "InnerSize",
112
110
  "InnerSize1",
111
+ "InnerUid",
113
112
  "InteractionConfig",
114
113
  "InteractionPoolingEncoder",
115
114
  "InteractionRoundRobinEncoder",
@@ -130,6 +129,7 @@ __all__ = [
130
129
  "ListEnginesResponse",
131
130
  "ListTablesResponse",
132
131
  "ListViewsResponse",
132
+ "LocationInner",
133
133
  "LossTypes",
134
134
  "Lr",
135
135
  "Lr1",
@@ -142,7 +142,7 @@ __all__ = [
142
142
  "MaxSeqLength2",
143
143
  "Mode",
144
144
  "Mode1",
145
- "Mode2",
145
+ "ModelsInner",
146
146
  "MongoDBTableConfig",
147
147
  "MySQLTableConfig",
148
148
  "NEpochs",
@@ -168,7 +168,6 @@ __all__ = [
168
168
  "PersonalFilter",
169
169
  "PipelineStageExplanation",
170
170
  "Policy",
171
- "PoolFn",
172
171
  "PoolingFunction",
173
172
  "PostgresTableConfig",
174
173
  "PosthogTableConfig",
@@ -177,7 +176,7 @@ __all__ = [
177
176
  "PrecomputedUserEmbedding",
178
177
  "Query",
179
178
  "Query1",
180
- "QueryAnyOf",
179
+ "QueryConfig",
181
180
  "QueryDefinition",
182
181
  "QueryEncoder",
183
182
  "QueryExplanation",
@@ -187,18 +186,22 @@ __all__ = [
187
186
  "RankItemAttributeValuesQueryConfig",
188
187
  "RankQueryConfig",
189
188
  "RankQueryConfigFilterInner",
190
- "RankQueryConfigReorderInner",
191
- "RankQueryConfigRetrieveInner",
192
189
  "RecreateRollout",
193
190
  "RedshiftTableConfig",
194
191
  "ReferenceTableConfig",
195
192
  "Regularization",
193
+ "ReorderInner",
194
+ "ReorderStepExplanation",
196
195
  "Request",
197
196
  "Request1",
198
197
  "RequestsPerSecondScalingPolicy",
198
+ "ResourceConfig",
199
199
  "ResponseGetViewDetailsViewsViewNameGet",
200
200
  "Result",
201
201
  "ResultEmbeddingsValue",
202
+ "RetrievalScoresValue",
203
+ "RetrieveInner",
204
+ "RetrieveStepExplanation",
202
205
  "Retriever",
203
206
  "Retriever1",
204
207
  "RolloutConfig",
@@ -212,8 +215,7 @@ __all__ = [
212
215
  "SchemaConfig",
213
216
  "Score",
214
217
  "ScoreEnsemble",
215
- "ScoreEnsemblePolicyConfig",
216
- "ScoreEnsemblePolicyConfigPoliciesInner",
218
+ "ScoreStepExplanation",
217
219
  "SearchConfig",
218
220
  "SegmentTableConfig",
219
221
  "SequenceLength",
@@ -222,21 +224,15 @@ __all__ = [
222
224
  "ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig",
223
225
  "ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig",
224
226
  "ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig",
225
- "ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig",
226
227
  "ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig",
227
228
  "ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig",
228
229
  "ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig",
229
- "ShapedInternalRecsysPoliciesItemContentSimilarityModelPolicyItemContentSimilarityModelPolicyConfig",
230
230
  "ShapedInternalRecsysPoliciesLightgbmModelPolicyLightgbmModelPolicyLightGBMModelPolicyConfig",
231
231
  "ShapedInternalRecsysPoliciesNgramModelPolicyNgramModelPolicyConfig",
232
- "ShapedInternalRecsysPoliciesPopularModelPolicyPopularModelPolicyConfig",
233
- "ShapedInternalRecsysPoliciesRandomModelPolicyRandomModelPolicyConfig",
234
- "ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig",
235
232
  "ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig",
236
233
  "ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig",
237
234
  "ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig",
238
235
  "ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig",
239
- "ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig",
240
236
  "ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig",
241
237
  "ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig",
242
238
  "ShopifyTableConfig",
@@ -244,23 +240,21 @@ __all__ = [
244
240
  "SnowflakeTableConfig",
245
241
  "StemmerTokenizer",
246
242
  "StepExplanation",
243
+ "StepsInner",
247
244
  "Strategy",
248
245
  "Table",
249
246
  "TableDeploymentType",
250
247
  "TableInsertArguments",
251
248
  "TableInsertResponse",
252
- "TextEncoding",
253
249
  "TextSearchRetrieveStep",
254
250
  "TimeFrequency",
255
251
  "TimeWindow",
256
- "TimeWindowInDays",
257
252
  "Tokenizer",
258
253
  "TrainedModelEncoder",
259
254
  "TrainingComputeConfig",
260
255
  "TrainingConfig",
261
- "TrainingConfigModelsInner",
262
256
  "TrainingStrategy",
263
- "TrendingMode",
257
+ "TransformStatus",
264
258
  "TruncateFilterStep",
265
259
  "TunableBool",
266
260
  "TunableFloat",
@@ -268,20 +262,18 @@ __all__ = [
268
262
  "TunableIntCategorical",
269
263
  "TunableString",
270
264
  "TuningConfig",
271
- "Type",
272
265
  "UpdateTableResponse",
273
266
  "UpdateViewResponse",
274
267
  "UserAttributePoolingEncoder",
268
+ "UserInner",
275
269
  "ValSplit",
276
270
  "ValidationError",
277
- "ValidationErrorLocInner",
278
271
  "ValueType",
279
272
  "VectorSearchMode",
280
273
  "View",
281
274
  "ViewDetailsAI",
282
275
  "ViewDetailsAISchemaValue",
283
276
  "ViewDetailsSQL",
284
- "ViewStatus",
285
277
  "WeightDecay",
286
278
  "WhitespaceTokenizer",
287
279
  "WindowSize",
@@ -309,7 +301,6 @@ from shaped.autogen.models.ai_enrichment_view_config import AIEnrichmentViewConf
309
301
  from shaped.autogen.models.aws_pinpoint_table_config import AWSPinpointTableConfig as AWSPinpointTableConfig
310
302
  from shaped.autogen.models.algorithm import Algorithm as Algorithm
311
303
  from shaped.autogen.models.amplitude_table_config import AmplitudeTableConfig as AmplitudeTableConfig
312
- from shaped.autogen.models.ascending import Ascending as Ascending
313
304
  from shaped.autogen.models.attn_dropout_prob import AttnDropoutProb as AttnDropoutProb
314
305
  from shaped.autogen.models.attribute_journey import AttributeJourney as AttributeJourney
315
306
  from shaped.autogen.models.attribute_value import AttributeValue as AttributeValue
@@ -341,7 +332,6 @@ from shaped.autogen.models.delete_engine_response import DeleteEngineResponse as
341
332
  from shaped.autogen.models.delete_table_response import DeleteTableResponse as DeleteTableResponse
342
333
  from shaped.autogen.models.delete_view_response import DeleteViewResponse as DeleteViewResponse
343
334
  from shaped.autogen.models.deployment_config import DeploymentConfig as DeploymentConfig
344
- from shaped.autogen.models.distance_function import DistanceFunction as DistanceFunction
345
335
  from shaped.autogen.models.diversity_reorder_step import DiversityReorderStep as DiversityReorderStep
346
336
  from shaped.autogen.models.dropout_rate import DropoutRate as DropoutRate
347
337
  from shaped.autogen.models.dynamo_db_table_config import DynamoDBTableConfig as DynamoDBTableConfig
@@ -352,12 +342,10 @@ from shaped.autogen.models.embedding_dim import EmbeddingDim as EmbeddingDim
352
342
  from shaped.autogen.models.embedding_dims import EmbeddingDims as EmbeddingDims
353
343
  from shaped.autogen.models.embedding_size import EmbeddingSize as EmbeddingSize
354
344
  from shaped.autogen.models.encoder import Encoder as Encoder
355
- from shaped.autogen.models.encoding_pooling_strategy import EncodingPoolingStrategy as EncodingPoolingStrategy
356
345
  from shaped.autogen.models.engine import Engine as Engine
357
346
  from shaped.autogen.models.engine_config_v2 import EngineConfigV2 as EngineConfigV2
358
347
  from shaped.autogen.models.engine_details_response import EngineDetailsResponse as EngineDetailsResponse
359
348
  from shaped.autogen.models.engine_schema import EngineSchema as EngineSchema
360
- from shaped.autogen.models.engine_schema_user_inner import EngineSchemaUserInner as EngineSchemaUserInner
361
349
  from shaped.autogen.models.entity_config import EntityConfig as EntityConfig
362
350
  from shaped.autogen.models.entity_journey import EntityJourney as EntityJourney
363
351
  from shaped.autogen.models.entity_type import EntityType as EntityType
@@ -370,9 +358,11 @@ from shaped.autogen.models.feature import Feature as Feature
370
358
  from shaped.autogen.models.feature_type import FeatureType as FeatureType
371
359
  from shaped.autogen.models.file_table_config import FileTableConfig as FileTableConfig
372
360
  from shaped.autogen.models.filter_config import FilterConfig as FilterConfig
373
- from shaped.autogen.models.filter_dataset import FilterDataset as FilterDataset
374
361
  from shaped.autogen.models.filter_index_type import FilterIndexType as FilterIndexType
375
362
  from shaped.autogen.models.filter_retrieve_step import FilterRetrieveStep as FilterRetrieveStep
363
+ from shaped.autogen.models.filter_step_explanation import FilterStepExplanation as FilterStepExplanation
364
+ from shaped.autogen.models.filter_table import FilterTable as FilterTable
365
+ from shaped.autogen.models.filter_type import FilterType as FilterType
376
366
  from shaped.autogen.models.global_filter import GlobalFilter as GlobalFilter
377
367
  from shaped.autogen.models.http_validation_error import HTTPValidationError as HTTPValidationError
378
368
  from shaped.autogen.models.hidden_dropout_prob import HiddenDropoutProb as HiddenDropoutProb
@@ -382,8 +372,10 @@ from shaped.autogen.models.http_problem_response import HttpProblemResponse as H
382
372
  from shaped.autogen.models.hugging_face_encoder import HuggingFaceEncoder as HuggingFaceEncoder
383
373
  from shaped.autogen.models.iceberg_table_config import IcebergTableConfig as IcebergTableConfig
384
374
  from shaped.autogen.models.index_config import IndexConfig as IndexConfig
375
+ from shaped.autogen.models.inner_entity_id import InnerEntityId as InnerEntityId
385
376
  from shaped.autogen.models.inner_size import InnerSize as InnerSize
386
377
  from shaped.autogen.models.inner_size1 import InnerSize1 as InnerSize1
378
+ from shaped.autogen.models.inner_uid import InnerUid as InnerUid
387
379
  from shaped.autogen.models.interaction_config import InteractionConfig as InteractionConfig
388
380
  from shaped.autogen.models.interaction_pooling_encoder import InteractionPoolingEncoder as InteractionPoolingEncoder
389
381
  from shaped.autogen.models.interaction_round_robin_encoder import InteractionRoundRobinEncoder as InteractionRoundRobinEncoder
@@ -404,6 +396,7 @@ from shaped.autogen.models.lexical_search_mode import LexicalSearchMode as Lexic
404
396
  from shaped.autogen.models.list_engines_response import ListEnginesResponse as ListEnginesResponse
405
397
  from shaped.autogen.models.list_tables_response import ListTablesResponse as ListTablesResponse
406
398
  from shaped.autogen.models.list_views_response import ListViewsResponse as ListViewsResponse
399
+ from shaped.autogen.models.location_inner import LocationInner as LocationInner
407
400
  from shaped.autogen.models.loss_types import LossTypes as LossTypes
408
401
  from shaped.autogen.models.lr import Lr as Lr
409
402
  from shaped.autogen.models.lr1 import Lr1 as Lr1
@@ -416,7 +409,7 @@ from shaped.autogen.models.max_seq_length1 import MaxSeqLength1 as MaxSeqLength1
416
409
  from shaped.autogen.models.max_seq_length2 import MaxSeqLength2 as MaxSeqLength2
417
410
  from shaped.autogen.models.mode import Mode as Mode
418
411
  from shaped.autogen.models.mode1 import Mode1 as Mode1
419
- from shaped.autogen.models.mode2 import Mode2 as Mode2
412
+ from shaped.autogen.models.models_inner import ModelsInner as ModelsInner
420
413
  from shaped.autogen.models.mongo_db_table_config import MongoDBTableConfig as MongoDBTableConfig
421
414
  from shaped.autogen.models.my_sql_table_config import MySQLTableConfig as MySQLTableConfig
422
415
  from shaped.autogen.models.n_epochs import NEpochs as NEpochs
@@ -442,7 +435,6 @@ from shaped.autogen.models.passthrough_score import PassthroughScore as Passthro
442
435
  from shaped.autogen.models.personal_filter import PersonalFilter as PersonalFilter
443
436
  from shaped.autogen.models.pipeline_stage_explanation import PipelineStageExplanation as PipelineStageExplanation
444
437
  from shaped.autogen.models.policy import Policy as Policy
445
- from shaped.autogen.models.pool_fn import PoolFn as PoolFn
446
438
  from shaped.autogen.models.pooling_function import PoolingFunction as PoolingFunction
447
439
  from shaped.autogen.models.postgres_table_config import PostgresTableConfig as PostgresTableConfig
448
440
  from shaped.autogen.models.posthog_table_config import PosthogTableConfig as PosthogTableConfig
@@ -451,7 +443,7 @@ from shaped.autogen.models.precomputed_item_embedding import PrecomputedItemEmbe
451
443
  from shaped.autogen.models.precomputed_user_embedding import PrecomputedUserEmbedding as PrecomputedUserEmbedding
452
444
  from shaped.autogen.models.query import Query as Query
453
445
  from shaped.autogen.models.query1 import Query1 as Query1
454
- from shaped.autogen.models.query_any_of import QueryAnyOf as QueryAnyOf
446
+ from shaped.autogen.models.query_config import QueryConfig as QueryConfig
455
447
  from shaped.autogen.models.query_definition import QueryDefinition as QueryDefinition
456
448
  from shaped.autogen.models.query_encoder import QueryEncoder as QueryEncoder
457
449
  from shaped.autogen.models.query_explanation import QueryExplanation as QueryExplanation
@@ -461,18 +453,22 @@ from shaped.autogen.models.query_table_config import QueryTableConfig as QueryTa
461
453
  from shaped.autogen.models.rank_item_attribute_values_query_config import RankItemAttributeValuesQueryConfig as RankItemAttributeValuesQueryConfig
462
454
  from shaped.autogen.models.rank_query_config import RankQueryConfig as RankQueryConfig
463
455
  from shaped.autogen.models.rank_query_config_filter_inner import RankQueryConfigFilterInner as RankQueryConfigFilterInner
464
- from shaped.autogen.models.rank_query_config_reorder_inner import RankQueryConfigReorderInner as RankQueryConfigReorderInner
465
- from shaped.autogen.models.rank_query_config_retrieve_inner import RankQueryConfigRetrieveInner as RankQueryConfigRetrieveInner
466
456
  from shaped.autogen.models.recreate_rollout import RecreateRollout as RecreateRollout
467
457
  from shaped.autogen.models.redshift_table_config import RedshiftTableConfig as RedshiftTableConfig
468
458
  from shaped.autogen.models.reference_table_config import ReferenceTableConfig as ReferenceTableConfig
469
459
  from shaped.autogen.models.regularization import Regularization as Regularization
460
+ from shaped.autogen.models.reorder_inner import ReorderInner as ReorderInner
461
+ from shaped.autogen.models.reorder_step_explanation import ReorderStepExplanation as ReorderStepExplanation
470
462
  from shaped.autogen.models.request import Request as Request
471
463
  from shaped.autogen.models.request1 import Request1 as Request1
472
464
  from shaped.autogen.models.requests_per_second_scaling_policy import RequestsPerSecondScalingPolicy as RequestsPerSecondScalingPolicy
465
+ from shaped.autogen.models.resource_config import ResourceConfig as ResourceConfig
473
466
  from shaped.autogen.models.response_get_view_details_views_view_name_get import ResponseGetViewDetailsViewsViewNameGet as ResponseGetViewDetailsViewsViewNameGet
474
467
  from shaped.autogen.models.result import Result as Result
475
468
  from shaped.autogen.models.result_embeddings_value import ResultEmbeddingsValue as ResultEmbeddingsValue
469
+ from shaped.autogen.models.retrieval_scores_value import RetrievalScoresValue as RetrievalScoresValue
470
+ from shaped.autogen.models.retrieve_inner import RetrieveInner as RetrieveInner
471
+ from shaped.autogen.models.retrieve_step_explanation import RetrieveStepExplanation as RetrieveStepExplanation
476
472
  from shaped.autogen.models.retriever import Retriever as Retriever
477
473
  from shaped.autogen.models.retriever1 import Retriever1 as Retriever1
478
474
  from shaped.autogen.models.rollout_config import RolloutConfig as RolloutConfig
@@ -486,8 +482,7 @@ from shaped.autogen.models.saved_query_request import SavedQueryRequest as Saved
486
482
  from shaped.autogen.models.schema_config import SchemaConfig as SchemaConfig
487
483
  from shaped.autogen.models.score import Score as Score
488
484
  from shaped.autogen.models.score_ensemble import ScoreEnsemble as ScoreEnsemble
489
- from shaped.autogen.models.score_ensemble_policy_config import ScoreEnsemblePolicyConfig as ScoreEnsemblePolicyConfig
490
- from shaped.autogen.models.score_ensemble_policy_config_policies_inner import ScoreEnsemblePolicyConfigPoliciesInner as ScoreEnsemblePolicyConfigPoliciesInner
485
+ from shaped.autogen.models.score_step_explanation import ScoreStepExplanation as ScoreStepExplanation
491
486
  from shaped.autogen.models.search_config import SearchConfig as SearchConfig
492
487
  from shaped.autogen.models.segment_table_config import SegmentTableConfig as SegmentTableConfig
493
488
  from shaped.autogen.models.sequence_length import SequenceLength as SequenceLength
@@ -496,21 +491,15 @@ from shaped.autogen.models.setup_engine_response import SetupEngineResponse as S
496
491
  from shaped.autogen.models.shaped_internal_recsys_policies_als_model_policy_als_model_policy_config import ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig as ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig
497
492
  from shaped.autogen.models.shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config import ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig as ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeeformerModelPolicyConfig
498
493
  from shaped.autogen.models.shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config import ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig as ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyConfig
499
- from shaped.autogen.models.shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config import ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig as ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig
500
494
  from shaped.autogen.models.shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config import ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig as ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig
501
495
  from shaped.autogen.models.shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config import ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig as ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig
502
496
  from shaped.autogen.models.shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config import ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig as ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig
503
- from shaped.autogen.models.shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config import ShapedInternalRecsysPoliciesItemContentSimilarityModelPolicyItemContentSimilarityModelPolicyConfig as ShapedInternalRecsysPoliciesItemContentSimilarityModelPolicyItemContentSimilarityModelPolicyConfig
504
497
  from shaped.autogen.models.shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config import ShapedInternalRecsysPoliciesLightgbmModelPolicyLightgbmModelPolicyLightGBMModelPolicyConfig as ShapedInternalRecsysPoliciesLightgbmModelPolicyLightgbmModelPolicyLightGBMModelPolicyConfig
505
498
  from shaped.autogen.models.shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config import ShapedInternalRecsysPoliciesNgramModelPolicyNgramModelPolicyConfig as ShapedInternalRecsysPoliciesNgramModelPolicyNgramModelPolicyConfig
506
- from shaped.autogen.models.shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config import ShapedInternalRecsysPoliciesPopularModelPolicyPopularModelPolicyConfig as ShapedInternalRecsysPoliciesPopularModelPolicyPopularModelPolicyConfig
507
- from shaped.autogen.models.shaped_internal_recsys_policies_random_model_policy_random_model_policy_config import ShapedInternalRecsysPoliciesRandomModelPolicyRandomModelPolicyConfig as ShapedInternalRecsysPoliciesRandomModelPolicyRandomModelPolicyConfig
508
- from shaped.autogen.models.shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config import ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig as ShapedInternalRecsysPoliciesRecentlyPopularPolicyRecentlyPopularPolicyConfig
509
499
  from shaped.autogen.models.shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config import ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig as ShapedInternalRecsysPoliciesRisingPopularPolicyRisingPopularPolicyConfig
510
500
  from shaped.autogen.models.shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config import ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig as ShapedInternalRecsysPoliciesSasrecModelPolicySasrecModelPolicySASRecModelPolicyConfig
511
501
  from shaped.autogen.models.shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config import ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig as ShapedInternalRecsysPoliciesSvdModelPolicySVDModelPolicyConfig
512
502
  from shaped.autogen.models.shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config import ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig as ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig
513
- from shaped.autogen.models.shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config import ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig as ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig
514
503
  from shaped.autogen.models.shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config import ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig as ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig
515
504
  from shaped.autogen.models.shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config import ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig as ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig
516
505
  from shaped.autogen.models.shopify_table_config import ShopifyTableConfig as ShopifyTableConfig
@@ -518,23 +507,21 @@ from shaped.autogen.models.similarity_retrieve_step import SimilarityRetrieveSte
518
507
  from shaped.autogen.models.snowflake_table_config import SnowflakeTableConfig as SnowflakeTableConfig
519
508
  from shaped.autogen.models.stemmer_tokenizer import StemmerTokenizer as StemmerTokenizer
520
509
  from shaped.autogen.models.step_explanation import StepExplanation as StepExplanation
510
+ from shaped.autogen.models.steps_inner import StepsInner as StepsInner
521
511
  from shaped.autogen.models.strategy import Strategy as Strategy
522
512
  from shaped.autogen.models.table import Table as Table
523
513
  from shaped.autogen.models.table_deployment_type import TableDeploymentType as TableDeploymentType
524
514
  from shaped.autogen.models.table_insert_arguments import TableInsertArguments as TableInsertArguments
525
515
  from shaped.autogen.models.table_insert_response import TableInsertResponse as TableInsertResponse
526
- from shaped.autogen.models.text_encoding import TextEncoding as TextEncoding
527
516
  from shaped.autogen.models.text_search_retrieve_step import TextSearchRetrieveStep as TextSearchRetrieveStep
528
517
  from shaped.autogen.models.time_frequency import TimeFrequency as TimeFrequency
529
518
  from shaped.autogen.models.time_window import TimeWindow as TimeWindow
530
- from shaped.autogen.models.time_window_in_days import TimeWindowInDays as TimeWindowInDays
531
519
  from shaped.autogen.models.tokenizer import Tokenizer as Tokenizer
532
520
  from shaped.autogen.models.trained_model_encoder import TrainedModelEncoder as TrainedModelEncoder
533
521
  from shaped.autogen.models.training_compute_config import TrainingComputeConfig as TrainingComputeConfig
534
522
  from shaped.autogen.models.training_config import TrainingConfig as TrainingConfig
535
- from shaped.autogen.models.training_config_models_inner import TrainingConfigModelsInner as TrainingConfigModelsInner
536
523
  from shaped.autogen.models.training_strategy import TrainingStrategy as TrainingStrategy
537
- from shaped.autogen.models.trending_mode import TrendingMode as TrendingMode
524
+ from shaped.autogen.models.transform_status import TransformStatus as TransformStatus
538
525
  from shaped.autogen.models.truncate_filter_step import TruncateFilterStep as TruncateFilterStep
539
526
  from shaped.autogen.models.tunable_bool import TunableBool as TunableBool
540
527
  from shaped.autogen.models.tunable_float import TunableFloat as TunableFloat
@@ -542,20 +529,18 @@ from shaped.autogen.models.tunable_int import TunableInt as TunableInt
542
529
  from shaped.autogen.models.tunable_int_categorical import TunableIntCategorical as TunableIntCategorical
543
530
  from shaped.autogen.models.tunable_string import TunableString as TunableString
544
531
  from shaped.autogen.models.tuning_config import TuningConfig as TuningConfig
545
- from shaped.autogen.models.type import Type as Type
546
532
  from shaped.autogen.models.update_table_response import UpdateTableResponse as UpdateTableResponse
547
533
  from shaped.autogen.models.update_view_response import UpdateViewResponse as UpdateViewResponse
548
534
  from shaped.autogen.models.user_attribute_pooling_encoder import UserAttributePoolingEncoder as UserAttributePoolingEncoder
535
+ from shaped.autogen.models.user_inner import UserInner as UserInner
549
536
  from shaped.autogen.models.val_split import ValSplit as ValSplit
550
537
  from shaped.autogen.models.validation_error import ValidationError as ValidationError
551
- from shaped.autogen.models.validation_error_loc_inner import ValidationErrorLocInner as ValidationErrorLocInner
552
538
  from shaped.autogen.models.value_type import ValueType as ValueType
553
539
  from shaped.autogen.models.vector_search_mode import VectorSearchMode as VectorSearchMode
554
540
  from shaped.autogen.models.view import View as View
555
541
  from shaped.autogen.models.view_details_ai import ViewDetailsAI as ViewDetailsAI
556
542
  from shaped.autogen.models.view_details_ai_schema_value import ViewDetailsAISchemaValue as ViewDetailsAISchemaValue
557
543
  from shaped.autogen.models.view_details_sql import ViewDetailsSQL as ViewDetailsSQL
558
- from shaped.autogen.models.view_status import ViewStatus as ViewStatus
559
544
  from shaped.autogen.models.weight_decay import WeightDecay as WeightDecay
560
545
  from shaped.autogen.models.whitespace_tokenizer import WhitespaceTokenizer as WhitespaceTokenizer
561
546
  from shaped.autogen.models.window_size import WindowSize as WindowSize
@@ -1,15 +1,14 @@
1
1
  # coding: utf-8
2
2
 
3
3
  """
4
- Shaped API
4
+ Shaped API
5
5
 
6
- Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. 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`
6
+ Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
8
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
9
 
11
- Do not edit the class manually.
12
- """ # noqa: E501
10
+ Do not edit the class manually.
11
+ """ # noqa: E501
13
12
 
14
13
  import warnings
15
14
  from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt