shaped 2.0.2__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 (294) hide show
  1. shaped/__init__.py +47 -42
  2. shaped/autogen/__init__.py +37 -51
  3. shaped/autogen/api/engine_api.py +1 -1
  4. shaped/autogen/api/query_api.py +8 -68
  5. shaped/autogen/api/table_api.py +1 -1
  6. shaped/autogen/api/view_api.py +1 -1
  7. shaped/autogen/api_client.py +4 -4
  8. shaped/autogen/configuration.py +5 -3
  9. shaped/autogen/exceptions.py +7 -4
  10. shaped/autogen/models/__init__.py +19 -26
  11. shaped/autogen/models/ai_enrichment_view_config.py +1 -1
  12. shaped/autogen/models/algorithm.py +1 -1
  13. shaped/autogen/models/amplitude_table_config.py +1 -1
  14. shaped/autogen/models/ascending.py +29 -17
  15. shaped/autogen/models/attn_dropout_prob.py +1 -1
  16. shaped/autogen/models/attribute_journey.py +1 -1
  17. shaped/autogen/models/attribute_value.py +1 -1
  18. shaped/autogen/models/autoscaling_config.py +1 -1
  19. shaped/autogen/models/aws_pinpoint_table_config.py +1 -1
  20. shaped/autogen/models/batch_size.py +1 -1
  21. shaped/autogen/models/batch_size1.py +1 -1
  22. shaped/autogen/models/batch_size2.py +1 -1
  23. shaped/autogen/models/big_query_table_config.py +1 -1
  24. shaped/autogen/models/bm25.py +1 -1
  25. shaped/autogen/models/boosted_reorder_step.py +1 -1
  26. shaped/autogen/models/canary_rollout.py +1 -1
  27. shaped/autogen/models/candidate_attributes_retrieve_step.py +1 -14
  28. shaped/autogen/models/candidate_ids_retrieve_step.py +1 -1
  29. shaped/autogen/models/candidate_retrieval_strategy.py +1 -1
  30. shaped/autogen/models/clickhouse_table_config.py +1 -1
  31. shaped/autogen/models/column_order_retrieve_step.py +1 -1
  32. shaped/autogen/models/column_ordering.py +1 -1
  33. shaped/autogen/models/create_table_response.py +1 -1
  34. shaped/autogen/models/create_view_response.py +1 -1
  35. shaped/autogen/models/custom_table_config.py +1 -1
  36. shaped/autogen/models/data_compute_config.py +1 -1
  37. shaped/autogen/models/data_config.py +1 -1
  38. shaped/autogen/models/data_config_interaction_table.py +1 -1
  39. shaped/autogen/models/data_split_config.py +1 -1
  40. shaped/autogen/models/data_split_strategy.py +1 -1
  41. shaped/autogen/models/data_tier.py +1 -1
  42. shaped/autogen/models/default.py +1 -1
  43. shaped/autogen/models/delete_engine_response.py +1 -1
  44. shaped/autogen/models/delete_table_response.py +1 -1
  45. shaped/autogen/models/delete_view_response.py +1 -1
  46. shaped/autogen/models/deployment_config.py +2 -8
  47. shaped/autogen/models/distance_function.py +5 -5
  48. shaped/autogen/models/diversity_reorder_step.py +1 -1
  49. shaped/autogen/models/dropout_rate.py +1 -1
  50. shaped/autogen/models/dynamo_db_table_config.py +1 -1
  51. shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +1 -1
  52. shaped/autogen/models/embedder_batch_size.py +1 -1
  53. shaped/autogen/models/embedding_config.py +1 -1
  54. shaped/autogen/models/embedding_dim.py +1 -1
  55. shaped/autogen/models/embedding_dims.py +1 -1
  56. shaped/autogen/models/embedding_size.py +1 -1
  57. shaped/autogen/models/encoder.py +1 -1
  58. shaped/autogen/models/encoding_pooling_strategy.py +5 -5
  59. shaped/autogen/models/engine.py +1 -1
  60. shaped/autogen/models/engine_config_v2.py +1 -1
  61. shaped/autogen/models/engine_details_response.py +1 -1
  62. shaped/autogen/models/engine_schema.py +8 -8
  63. shaped/autogen/models/engine_schema_user_inner.py +30 -18
  64. shaped/autogen/models/entity_config.py +1 -1
  65. shaped/autogen/models/entity_journey.py +28 -19
  66. shaped/autogen/models/entity_type.py +1 -1
  67. shaped/autogen/models/evaluation_config.py +1 -1
  68. shaped/autogen/models/exploration_reorder_step.py +1 -1
  69. shaped/autogen/models/expression_filter_step.py +1 -1
  70. shaped/autogen/models/factors.py +1 -1
  71. shaped/autogen/models/factors1.py +1 -1
  72. shaped/autogen/models/feature.py +1 -1
  73. shaped/autogen/models/feature_type.py +1 -1
  74. shaped/autogen/models/file_table_config.py +1 -1
  75. shaped/autogen/models/filter_config.py +14 -14
  76. shaped/autogen/models/filter_dataset.py +47 -23
  77. shaped/autogen/models/filter_index_type.py +1 -1
  78. shaped/autogen/models/filter_retrieve_step.py +1 -1
  79. shaped/autogen/models/filter_step_explanation.py +165 -0
  80. shaped/autogen/models/filter_table.py +140 -0
  81. shaped/autogen/models/filter_type.py +134 -0
  82. shaped/autogen/models/global_filter.py +1 -1
  83. shaped/autogen/models/hidden_dropout_prob.py +1 -1
  84. shaped/autogen/models/hidden_size.py +1 -1
  85. shaped/autogen/models/hidden_size1.py +1 -1
  86. shaped/autogen/models/http_problem_response.py +1 -1
  87. shaped/autogen/models/http_validation_error.py +1 -1
  88. shaped/autogen/models/hugging_face_encoder.py +6 -4
  89. shaped/autogen/models/iceberg_table_config.py +1 -1
  90. shaped/autogen/models/index_config.py +1 -1
  91. shaped/autogen/models/inner_entity_id.py +144 -0
  92. shaped/autogen/models/inner_size.py +1 -1
  93. shaped/autogen/models/inner_size1.py +1 -1
  94. shaped/autogen/models/inner_uid.py +144 -0
  95. shaped/autogen/models/interaction_config.py +1 -1
  96. shaped/autogen/models/interaction_pooling_encoder.py +1 -1
  97. shaped/autogen/models/interaction_round_robin_encoder.py +1 -1
  98. shaped/autogen/models/item_attribute_pooling_encoder.py +1 -14
  99. shaped/autogen/models/journey.py +1 -1
  100. shaped/autogen/models/kafka_table_config.py +1 -1
  101. shaped/autogen/models/kinesis_table_config.py +1 -1
  102. shaped/autogen/models/kinesis_table_config_column_schema_value.py +1 -1
  103. shaped/autogen/models/label.py +1 -1
  104. shaped/autogen/models/label_type.py +1 -2
  105. shaped/autogen/models/laplace_smoothing.py +1 -1
  106. shaped/autogen/models/latency_scaling_policy.py +1 -1
  107. shaped/autogen/models/learning_rate.py +1 -1
  108. shaped/autogen/models/learning_rate1.py +1 -1
  109. shaped/autogen/models/learning_rate2.py +1 -1
  110. shaped/autogen/models/learning_rate3.py +1 -1
  111. shaped/autogen/models/lexical_search_mode.py +3 -3
  112. shaped/autogen/models/list_engines_response.py +1 -1
  113. shaped/autogen/models/list_tables_response.py +1 -1
  114. shaped/autogen/models/list_views_response.py +1 -1
  115. shaped/autogen/models/location_inner.py +138 -0
  116. shaped/autogen/models/loss_types.py +1 -1
  117. shaped/autogen/models/lr.py +1 -1
  118. shaped/autogen/models/lr1.py +1 -1
  119. shaped/autogen/models/lr2.py +1 -1
  120. shaped/autogen/models/max_depth.py +1 -1
  121. shaped/autogen/models/max_leaves.py +1 -1
  122. shaped/autogen/models/max_seq_length.py +1 -1
  123. shaped/autogen/models/max_seq_length1.py +1 -1
  124. shaped/autogen/models/max_seq_length2.py +1 -1
  125. shaped/autogen/models/mode.py +1 -1
  126. shaped/autogen/models/mode1.py +20 -18
  127. shaped/autogen/models/mode2.py +32 -18
  128. shaped/autogen/models/models_inner.py +308 -0
  129. shaped/autogen/models/mongo_db_table_config.py +1 -1
  130. shaped/autogen/models/mssql_table_config.py +1 -1
  131. shaped/autogen/models/my_sql_table_config.py +1 -1
  132. shaped/autogen/models/n_epochs.py +1 -1
  133. shaped/autogen/models/n_epochs1.py +1 -1
  134. shaped/autogen/models/n_epochs2.py +1 -1
  135. shaped/autogen/models/n_estimators.py +1 -1
  136. shaped/autogen/models/n_heads.py +1 -1
  137. shaped/autogen/models/n_layers.py +1 -1
  138. shaped/autogen/models/neg_per_positive.py +1 -1
  139. shaped/autogen/models/negative_samples_count.py +1 -1
  140. shaped/autogen/models/ngram_tokenizer.py +1 -1
  141. shaped/autogen/models/no_op_config.py +1 -1
  142. shaped/autogen/models/num_blocks.py +1 -1
  143. shaped/autogen/models/num_heads.py +1 -1
  144. shaped/autogen/models/num_leaves.py +1 -1
  145. shaped/autogen/models/objective.py +1 -1
  146. shaped/autogen/models/objective1.py +1 -1
  147. shaped/autogen/models/online_store_config.py +1 -1
  148. shaped/autogen/models/pagination_config.py +1 -1
  149. shaped/autogen/models/parameter_definition.py +1 -1
  150. shaped/autogen/models/parameters_value.py +1 -1
  151. shaped/autogen/models/passthrough_score.py +1 -1
  152. shaped/autogen/models/personal_filter.py +1 -1
  153. shaped/autogen/models/pipeline_stage_explanation.py +4 -4
  154. shaped/autogen/models/policy.py +1 -1
  155. shaped/autogen/models/pool_fn.py +39 -21
  156. shaped/autogen/models/pooling_function.py +1 -1
  157. shaped/autogen/models/postgres_table_config.py +1 -1
  158. shaped/autogen/models/posthog_table_config.py +1 -1
  159. shaped/autogen/models/prebuilt_filter_step.py +1 -1
  160. shaped/autogen/models/precomputed_item_embedding.py +1 -1
  161. shaped/autogen/models/precomputed_user_embedding.py +1 -1
  162. shaped/autogen/models/query.py +15 -15
  163. shaped/autogen/models/query1.py +15 -15
  164. shaped/autogen/models/query_any_of.py +58 -26
  165. shaped/autogen/models/query_config.py +140 -0
  166. shaped/autogen/models/query_definition.py +1 -1
  167. shaped/autogen/models/query_encoder.py +1 -1
  168. shaped/autogen/models/query_explanation.py +7 -3
  169. shaped/autogen/models/query_request.py +1 -1
  170. shaped/autogen/models/query_result.py +1 -1
  171. shaped/autogen/models/query_table_config.py +1 -1
  172. shaped/autogen/models/rank_item_attribute_values_query_config.py +1 -1
  173. shaped/autogen/models/rank_query_config.py +7 -7
  174. shaped/autogen/models/rank_query_config_filter_inner.py +1 -1
  175. shaped/autogen/models/rank_query_config_reorder_inner.py +62 -25
  176. shaped/autogen/models/rank_query_config_retrieve_inner.py +100 -31
  177. shaped/autogen/models/recreate_rollout.py +1 -1
  178. shaped/autogen/models/redshift_table_config.py +1 -1
  179. shaped/autogen/models/reference_table_config.py +1 -1
  180. shaped/autogen/models/regularization.py +1 -1
  181. shaped/autogen/models/reorder_inner.py +149 -0
  182. shaped/autogen/models/reorder_step_explanation.py +207 -0
  183. shaped/autogen/models/request.py +1 -1
  184. shaped/autogen/models/request1.py +1 -1
  185. shaped/autogen/models/requests_per_second_scaling_policy.py +1 -1
  186. shaped/autogen/models/resource_config.py +100 -0
  187. shaped/autogen/models/response_get_view_details_views_view_name_get.py +1 -1
  188. shaped/autogen/models/result.py +1 -14
  189. shaped/autogen/models/result_embeddings_value.py +1 -1
  190. shaped/autogen/models/retrieval_scores_value.py +127 -0
  191. shaped/autogen/models/retrieve_inner.py +196 -0
  192. shaped/autogen/models/retrieve_step_explanation.py +172 -0
  193. shaped/autogen/models/retriever.py +1 -1
  194. shaped/autogen/models/retriever1.py +1 -1
  195. shaped/autogen/models/rollout_config.py +1 -1
  196. shaped/autogen/models/rudderstack_table_config.py +1 -1
  197. shaped/autogen/models/sampling_strategy.py +1 -1
  198. shaped/autogen/models/saved_query_info_response.py +18 -4
  199. shaped/autogen/models/saved_query_list_response.py +1 -1
  200. shaped/autogen/models/saved_query_request.py +1 -1
  201. shaped/autogen/models/schema_config.py +1 -1
  202. shaped/autogen/models/score.py +1 -1
  203. shaped/autogen/models/score_ensemble.py +1 -14
  204. shaped/autogen/models/score_ensemble_policy_config.py +49 -25
  205. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +456 -123
  206. shaped/autogen/models/score_step_explanation.py +224 -0
  207. shaped/autogen/models/search_config.py +1 -1
  208. shaped/autogen/models/segment_table_config.py +1 -1
  209. shaped/autogen/models/sequence_length.py +1 -1
  210. shaped/autogen/models/server_config.py +14 -1
  211. shaped/autogen/models/setup_engine_response.py +1 -1
  212. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +9 -3
  213. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +9 -3
  214. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +10 -4
  215. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +46 -27
  216. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +6 -4
  217. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +9 -3
  218. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +1 -1
  219. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +77 -34
  220. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +9 -3
  221. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +1 -1
  222. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +52 -28
  223. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +21 -17
  224. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +36 -23
  225. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +1 -1
  226. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +9 -3
  227. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +1 -1
  228. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +9 -3
  229. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +53 -31
  230. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +10 -4
  231. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +12 -6
  232. shaped/autogen/models/shopify_table_config.py +1 -1
  233. shaped/autogen/models/similarity_retrieve_step.py +6 -4
  234. shaped/autogen/models/snowflake_table_config.py +1 -1
  235. shaped/autogen/models/sql_transform_type.py +1 -1
  236. shaped/autogen/models/sql_view_config.py +1 -1
  237. shaped/autogen/models/stemmer_tokenizer.py +1 -1
  238. shaped/autogen/models/step_explanation.py +1 -1
  239. shaped/autogen/models/steps_inner.py +179 -0
  240. shaped/autogen/models/strategy.py +1 -1
  241. shaped/autogen/models/table.py +1 -1
  242. shaped/autogen/models/table_deployment_type.py +1 -1
  243. shaped/autogen/models/table_insert_arguments.py +3 -3
  244. shaped/autogen/models/table_insert_response.py +1 -1
  245. shaped/autogen/models/text_encoding.py +29 -17
  246. shaped/autogen/models/text_search_retrieve_step.py +1 -1
  247. shaped/autogen/models/time_frequency.py +1 -1
  248. shaped/autogen/models/time_window.py +1 -1
  249. shaped/autogen/models/time_window_in_days.py +29 -17
  250. shaped/autogen/models/tokenizer.py +1 -1
  251. shaped/autogen/models/trained_model_encoder.py +1 -1
  252. shaped/autogen/models/training_compute_config.py +4 -4
  253. shaped/autogen/models/training_config.py +4 -4
  254. shaped/autogen/models/training_config_models_inner.py +325 -93
  255. shaped/autogen/models/training_strategy.py +1 -1
  256. shaped/autogen/models/transform_status.py +41 -0
  257. shaped/autogen/models/trending_mode.py +4 -4
  258. shaped/autogen/models/truncate_filter_step.py +1 -1
  259. shaped/autogen/models/tunable_bool.py +1 -1
  260. shaped/autogen/models/tunable_float.py +1 -1
  261. shaped/autogen/models/tunable_int.py +1 -1
  262. shaped/autogen/models/tunable_int_categorical.py +1 -1
  263. shaped/autogen/models/tunable_string.py +1 -1
  264. shaped/autogen/models/tuning_config.py +1 -1
  265. shaped/autogen/models/type.py +36 -20
  266. shaped/autogen/models/update_table_response.py +1 -1
  267. shaped/autogen/models/update_view_response.py +1 -1
  268. shaped/autogen/models/user_attribute_pooling_encoder.py +1 -1
  269. shaped/autogen/models/user_inner.py +134 -0
  270. shaped/autogen/models/val_split.py +1 -1
  271. shaped/autogen/models/validation_error.py +4 -4
  272. shaped/autogen/models/validation_error_loc_inner.py +28 -16
  273. shaped/autogen/models/value_type.py +1 -1
  274. shaped/autogen/models/vector_search_mode.py +6 -4
  275. shaped/autogen/models/view.py +4 -4
  276. shaped/autogen/models/view_details_ai.py +6 -6
  277. shaped/autogen/models/view_details_ai_schema_value.py +1 -1
  278. shaped/autogen/models/view_details_sql.py +6 -6
  279. shaped/autogen/models/view_status.py +8 -8
  280. shaped/autogen/models/weight_decay.py +1 -1
  281. shaped/autogen/models/whitespace_tokenizer.py +1 -1
  282. shaped/autogen/models/window_size.py +1 -1
  283. shaped/autogen/rest.py +9 -9
  284. shaped/cli/shaped_cli.py +152 -29
  285. shaped/client.py +50 -43
  286. shaped/config_builders.py +110 -100
  287. shaped/query_builder.py +56 -49
  288. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/METADATA +2 -2
  289. shaped-2.0.4.dist-info/RECORD +296 -0
  290. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/WHEEL +1 -1
  291. shaped-2.0.2.dist-info/RECORD +0 -278
  292. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/entry_points.txt +0 -0
  293. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/top_level.txt +0 -0
  294. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/zip-safe +0 -0
@@ -0,0 +1,196 @@
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 json
17
+ import pprint
18
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
19
+ from typing import Any, List, Optional
20
+ from shaped.autogen.models.candidate_attributes_retrieve_step import CandidateAttributesRetrieveStep
21
+ from shaped.autogen.models.candidate_ids_retrieve_step import CandidateIdsRetrieveStep
22
+ from shaped.autogen.models.column_order_retrieve_step import ColumnOrderRetrieveStep
23
+ from shaped.autogen.models.filter_retrieve_step import FilterRetrieveStep
24
+ from shaped.autogen.models.similarity_retrieve_step import SimilarityRetrieveStep
25
+ from shaped.autogen.models.text_search_retrieve_step import TextSearchRetrieveStep
26
+ from pydantic import StrictStr, Field
27
+ from typing import Union, List, Set, Optional, Dict
28
+ from typing_extensions import Literal, Self
29
+
30
+ RETRIEVEINNER_ONE_OF_SCHEMAS = ["CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep"]
31
+
32
+ class RetrieveInner(BaseModel):
33
+ """
34
+ RetrieveInner
35
+ """
36
+ # data type: ColumnOrderRetrieveStep
37
+ oneof_schema_1_validator: Optional[ColumnOrderRetrieveStep] = None
38
+ # data type: TextSearchRetrieveStep
39
+ oneof_schema_2_validator: Optional[TextSearchRetrieveStep] = None
40
+ # data type: SimilarityRetrieveStep
41
+ oneof_schema_3_validator: Optional[SimilarityRetrieveStep] = None
42
+ # data type: FilterRetrieveStep
43
+ oneof_schema_4_validator: Optional[FilterRetrieveStep] = None
44
+ # data type: CandidateIdsRetrieveStep
45
+ oneof_schema_5_validator: Optional[CandidateIdsRetrieveStep] = None
46
+ # data type: CandidateAttributesRetrieveStep
47
+ oneof_schema_6_validator: Optional[CandidateAttributesRetrieveStep] = None
48
+ actual_instance: Optional[Union[CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep]] = None
49
+ one_of_schemas: Set[str] = { "CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep" }
50
+
51
+ model_config = ConfigDict(
52
+ validate_assignment=True,
53
+ protected_namespaces=(),
54
+ )
55
+
56
+
57
+ discriminator_value_class_map: Dict[str, str] = {
58
+ }
59
+
60
+ def __init__(self, *args, **kwargs) -> None:
61
+ if args:
62
+ if len(args) > 1:
63
+ raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
64
+ if kwargs:
65
+ raise ValueError("If a position argument is used, keyword arguments cannot be used.")
66
+ super().__init__(actual_instance=args[0])
67
+ else:
68
+ super().__init__(**kwargs)
69
+
70
+ @field_validator('actual_instance')
71
+ def actual_instance_must_validate_oneof(cls, v):
72
+ instance = RetrieveInner.model_construct()
73
+ error_messages = []
74
+ match = 0
75
+ # validate data type: ColumnOrderRetrieveStep
76
+ if not isinstance(v, ColumnOrderRetrieveStep):
77
+ error_messages.append(f"Error! Input type `{type(v)}` is not `ColumnOrderRetrieveStep`")
78
+ else:
79
+ match += 1
80
+ # validate data type: TextSearchRetrieveStep
81
+ if not isinstance(v, TextSearchRetrieveStep):
82
+ error_messages.append(f"Error! Input type `{type(v)}` is not `TextSearchRetrieveStep`")
83
+ else:
84
+ match += 1
85
+ # validate data type: SimilarityRetrieveStep
86
+ if not isinstance(v, SimilarityRetrieveStep):
87
+ error_messages.append(f"Error! Input type `{type(v)}` is not `SimilarityRetrieveStep`")
88
+ else:
89
+ match += 1
90
+ # validate data type: FilterRetrieveStep
91
+ if not isinstance(v, FilterRetrieveStep):
92
+ error_messages.append(f"Error! Input type `{type(v)}` is not `FilterRetrieveStep`")
93
+ else:
94
+ match += 1
95
+ # validate data type: CandidateIdsRetrieveStep
96
+ if not isinstance(v, CandidateIdsRetrieveStep):
97
+ error_messages.append(f"Error! Input type `{type(v)}` is not `CandidateIdsRetrieveStep`")
98
+ else:
99
+ match += 1
100
+ # validate data type: CandidateAttributesRetrieveStep
101
+ if not isinstance(v, CandidateAttributesRetrieveStep):
102
+ error_messages.append(f"Error! Input type `{type(v)}` is not `CandidateAttributesRetrieveStep`")
103
+ else:
104
+ match += 1
105
+ if match > 1:
106
+ # more than 1 match
107
+ raise ValueError("Multiple matches found when setting `actual_instance` in RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
108
+ elif match == 0:
109
+ # no match
110
+ raise ValueError("No match found when setting `actual_instance` in RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
111
+ else:
112
+ return v
113
+
114
+ @classmethod
115
+ def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
116
+ return cls.from_json(json.dumps(obj))
117
+
118
+ @classmethod
119
+ def from_json(cls, json_str: str) -> Self:
120
+ """Returns the object represented by the json string"""
121
+ instance = cls.model_construct()
122
+ error_messages = []
123
+ match = 0
124
+
125
+ # deserialize data into ColumnOrderRetrieveStep
126
+ try:
127
+ instance.actual_instance = ColumnOrderRetrieveStep.from_json(json_str)
128
+ match += 1
129
+ except (ValidationError, ValueError) as e:
130
+ error_messages.append(str(e))
131
+ # deserialize data into TextSearchRetrieveStep
132
+ try:
133
+ instance.actual_instance = TextSearchRetrieveStep.from_json(json_str)
134
+ match += 1
135
+ except (ValidationError, ValueError) as e:
136
+ error_messages.append(str(e))
137
+ # deserialize data into SimilarityRetrieveStep
138
+ try:
139
+ instance.actual_instance = SimilarityRetrieveStep.from_json(json_str)
140
+ match += 1
141
+ except (ValidationError, ValueError) as e:
142
+ error_messages.append(str(e))
143
+ # deserialize data into FilterRetrieveStep
144
+ try:
145
+ instance.actual_instance = FilterRetrieveStep.from_json(json_str)
146
+ match += 1
147
+ except (ValidationError, ValueError) as e:
148
+ error_messages.append(str(e))
149
+ # deserialize data into CandidateIdsRetrieveStep
150
+ try:
151
+ instance.actual_instance = CandidateIdsRetrieveStep.from_json(json_str)
152
+ match += 1
153
+ except (ValidationError, ValueError) as e:
154
+ error_messages.append(str(e))
155
+ # deserialize data into CandidateAttributesRetrieveStep
156
+ try:
157
+ instance.actual_instance = CandidateAttributesRetrieveStep.from_json(json_str)
158
+ match += 1
159
+ except (ValidationError, ValueError) as e:
160
+ error_messages.append(str(e))
161
+
162
+ if match > 1:
163
+ # more than 1 match
164
+ raise ValueError("Multiple matches found when deserializing the JSON string into RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
165
+ elif match == 0:
166
+ # no match
167
+ raise ValueError("No match found when deserializing the JSON string into RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
168
+ else:
169
+ return instance
170
+
171
+ def to_json(self) -> str:
172
+ """Returns the JSON representation of the actual instance"""
173
+ if self.actual_instance is None:
174
+ return "null"
175
+
176
+ if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
177
+ return self.actual_instance.to_json()
178
+ else:
179
+ return json.dumps(self.actual_instance)
180
+
181
+ def to_dict(self) -> Optional[Union[Dict[str, Any], CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep]]:
182
+ """Returns the dict representation of the actual instance"""
183
+ if self.actual_instance is None:
184
+ return None
185
+
186
+ if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
187
+ return self.actual_instance.to_dict()
188
+ else:
189
+ # primitive type
190
+ return self.actual_instance
191
+
192
+ def to_str(self) -> str:
193
+ """Returns the string representation of the actual instance"""
194
+ return pprint.pformat(self.model_dump())
195
+
196
+
@@ -0,0 +1,172 @@
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, StrictFloat, StrictInt, StrictStr
21
+ from typing import Any, ClassVar, Dict, List, Optional, Union
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class RetrieveStepExplanation(BaseModel):
26
+ """
27
+ Explanation for a retrieval step.
28
+ """ # noqa: E501
29
+ step_name: Optional[StrictStr] = None
30
+ step_type: Optional[StrictStr] = Field(default='', description="Type of step. Examples: 'column_order', 'similarity', 'text_search', 'prebuilt', 'expression', 'score_ensemble', 'diversity', etc.")
31
+ input_count: Optional[StrictInt] = None
32
+ output_count: Optional[StrictInt] = None
33
+ filtered_count: Optional[StrictInt] = None
34
+ execution_time_ms: Optional[Union[StrictFloat, StrictInt]] = None
35
+ metadata: Optional[Dict[str, Any]] = Field(default=None, description="Additional step-specific metadata. Contains implementation details specific to the step type.")
36
+ retrieval_method: Optional[StrictStr] = None
37
+ retrieved_count: Optional[StrictInt] = None
38
+ limit: Optional[StrictInt] = None
39
+ pagination_offset: Optional[StrictInt] = None
40
+ filter_predicate: Optional[StrictStr] = None
41
+ additional_properties: Dict[str, Any] = {}
42
+ __properties: ClassVar[List[str]] = ["step_name", "step_type", "input_count", "output_count", "filtered_count", "execution_time_ms", "metadata", "retrieval_method", "retrieved_count", "limit", "pagination_offset", "filter_predicate"]
43
+
44
+ model_config = ConfigDict(
45
+ populate_by_name=True,
46
+ validate_assignment=True,
47
+ protected_namespaces=(),
48
+ )
49
+
50
+
51
+ def to_str(self) -> str:
52
+ """Returns the string representation of the model using alias"""
53
+ return pprint.pformat(self.model_dump(by_alias=True))
54
+
55
+ def to_json(self) -> str:
56
+ """Returns the JSON representation of the model using alias"""
57
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
58
+ return json.dumps(self.to_dict())
59
+
60
+ @classmethod
61
+ def from_json(cls, json_str: str) -> Optional[Self]:
62
+ """Create an instance of RetrieveStepExplanation from a JSON string"""
63
+ return cls.from_dict(json.loads(json_str))
64
+
65
+ def to_dict(self) -> Dict[str, Any]:
66
+ """Return the dictionary representation of the model using alias.
67
+
68
+ This has the following differences from calling pydantic's
69
+ `self.model_dump(by_alias=True)`:
70
+
71
+ * `None` is only added to the output dict for nullable fields that
72
+ were set at model initialization. Other fields with value `None`
73
+ are ignored.
74
+ * Fields in `self.additional_properties` are added to the output dict.
75
+ """
76
+ excluded_fields: Set[str] = set([
77
+ "additional_properties",
78
+ ])
79
+
80
+ _dict = self.model_dump(
81
+ by_alias=True,
82
+ exclude=excluded_fields,
83
+ exclude_none=True,
84
+ )
85
+ # puts key-value pairs in additional_properties in the top level
86
+ if self.additional_properties is not None:
87
+ for _key, _value in self.additional_properties.items():
88
+ _dict[_key] = _value
89
+
90
+ # set to None if step_name (nullable) is None
91
+ # and model_fields_set contains the field
92
+ if self.step_name is None and "step_name" in self.model_fields_set:
93
+ _dict['step_name'] = None
94
+
95
+ # set to None if input_count (nullable) is None
96
+ # and model_fields_set contains the field
97
+ if self.input_count is None and "input_count" in self.model_fields_set:
98
+ _dict['input_count'] = None
99
+
100
+ # set to None if output_count (nullable) is None
101
+ # and model_fields_set contains the field
102
+ if self.output_count is None and "output_count" in self.model_fields_set:
103
+ _dict['output_count'] = None
104
+
105
+ # set to None if filtered_count (nullable) is None
106
+ # and model_fields_set contains the field
107
+ if self.filtered_count is None and "filtered_count" in self.model_fields_set:
108
+ _dict['filtered_count'] = None
109
+
110
+ # set to None if execution_time_ms (nullable) is None
111
+ # and model_fields_set contains the field
112
+ if self.execution_time_ms is None and "execution_time_ms" in self.model_fields_set:
113
+ _dict['execution_time_ms'] = None
114
+
115
+ # set to None if retrieval_method (nullable) is None
116
+ # and model_fields_set contains the field
117
+ if self.retrieval_method is None and "retrieval_method" in self.model_fields_set:
118
+ _dict['retrieval_method'] = None
119
+
120
+ # set to None if retrieved_count (nullable) is None
121
+ # and model_fields_set contains the field
122
+ if self.retrieved_count is None and "retrieved_count" in self.model_fields_set:
123
+ _dict['retrieved_count'] = None
124
+
125
+ # set to None if limit (nullable) is None
126
+ # and model_fields_set contains the field
127
+ if self.limit is None and "limit" in self.model_fields_set:
128
+ _dict['limit'] = None
129
+
130
+ # set to None if pagination_offset (nullable) is None
131
+ # and model_fields_set contains the field
132
+ if self.pagination_offset is None and "pagination_offset" in self.model_fields_set:
133
+ _dict['pagination_offset'] = None
134
+
135
+ # set to None if filter_predicate (nullable) is None
136
+ # and model_fields_set contains the field
137
+ if self.filter_predicate is None and "filter_predicate" in self.model_fields_set:
138
+ _dict['filter_predicate'] = None
139
+
140
+ return _dict
141
+
142
+ @classmethod
143
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
144
+ """Create an instance of RetrieveStepExplanation from a dict"""
145
+ if obj is None:
146
+ return None
147
+
148
+ if not isinstance(obj, dict):
149
+ return cls.model_validate(obj)
150
+
151
+ _obj = cls.model_validate({
152
+ "step_name": obj.get("step_name"),
153
+ "step_type": obj.get("step_type") if obj.get("step_type") is not None else '',
154
+ "input_count": obj.get("input_count"),
155
+ "output_count": obj.get("output_count"),
156
+ "filtered_count": obj.get("filtered_count"),
157
+ "execution_time_ms": obj.get("execution_time_ms"),
158
+ "metadata": obj.get("metadata"),
159
+ "retrieval_method": obj.get("retrieval_method"),
160
+ "retrieved_count": obj.get("retrieved_count"),
161
+ "limit": obj.get("limit"),
162
+ "pagination_offset": obj.get("pagination_offset"),
163
+ "filter_predicate": obj.get("filter_predicate")
164
+ })
165
+ # store additional fields in additional_properties
166
+ for _key in obj.keys():
167
+ if _key not in cls.__properties:
168
+ _obj.additional_properties[_key] = obj.get(_key)
169
+
170
+ return _obj
171
+
172
+
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -18,7 +18,7 @@ import re # noqa: F401
18
18
  import json
19
19
 
20
20
  from pydantic import BaseModel, ConfigDict, Field, StrictStr
21
- from typing import Any, ClassVar, Dict, List
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
22
  from typing import Optional, Set
23
23
  from typing_extensions import Self
24
24
 
@@ -28,7 +28,9 @@ class SavedQueryInfoResponse(BaseModel):
28
28
  """ # noqa: E501
29
29
  name: StrictStr = Field(description="The name of the saved query.")
30
30
  params: List[StrictStr] = Field(description="List of parameter names that this query accepts.")
31
- __properties: ClassVar[List[str]] = ["name", "params"]
31
+ query: Optional[StrictStr] = None
32
+ query_type: Optional[StrictStr] = None
33
+ __properties: ClassVar[List[str]] = ["name", "params", "query", "query_type"]
32
34
 
33
35
  model_config = ConfigDict(
34
36
  populate_by_name=True,
@@ -69,6 +71,16 @@ class SavedQueryInfoResponse(BaseModel):
69
71
  exclude=excluded_fields,
70
72
  exclude_none=True,
71
73
  )
74
+ # set to None if query (nullable) is None
75
+ # and model_fields_set contains the field
76
+ if self.query is None and "query" in self.model_fields_set:
77
+ _dict['query'] = None
78
+
79
+ # set to None if query_type (nullable) is None
80
+ # and model_fields_set contains the field
81
+ if self.query_type is None and "query_type" in self.model_fields_set:
82
+ _dict['query_type'] = None
83
+
72
84
  return _dict
73
85
 
74
86
  @classmethod
@@ -82,7 +94,9 @@ class SavedQueryInfoResponse(BaseModel):
82
94
 
83
95
  _obj = cls.model_validate({
84
96
  "name": obj.get("name"),
85
- "params": obj.get("params")
97
+ "params": obj.get("params"),
98
+ "query": obj.get("query"),
99
+ "query_type": obj.get("query_type")
86
100
  })
87
101
  return _obj
88
102
 
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
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
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -32,7 +32,6 @@ class ScoreEnsemble(BaseModel):
32
32
  input_interactions_item_ids: Optional[List[Any]] = None
33
33
  name: Optional[StrictStr] = None
34
34
  type: Optional[StrictStr] = Field(default='score_ensemble', description="Score step type discriminator.")
35
- additional_properties: Dict[str, Any] = {}
36
35
  __properties: ClassVar[List[str]] = ["value_model", "input_user_id", "input_user_features", "input_interactions_item_ids", "name", "type"]
37
36
 
38
37
  @field_validator('type')
@@ -75,10 +74,8 @@ class ScoreEnsemble(BaseModel):
75
74
  * `None` is only added to the output dict for nullable fields that
76
75
  were set at model initialization. Other fields with value `None`
77
76
  are ignored.
78
- * Fields in `self.additional_properties` are added to the output dict.
79
77
  """
80
78
  excluded_fields: Set[str] = set([
81
- "additional_properties",
82
79
  ])
83
80
 
84
81
  _dict = self.model_dump(
@@ -86,11 +83,6 @@ class ScoreEnsemble(BaseModel):
86
83
  exclude=excluded_fields,
87
84
  exclude_none=True,
88
85
  )
89
- # puts key-value pairs in additional_properties in the top level
90
- if self.additional_properties is not None:
91
- for _key, _value in self.additional_properties.items():
92
- _dict[_key] = _value
93
-
94
86
  # set to None if input_user_id (nullable) is None
95
87
  # and model_fields_set contains the field
96
88
  if self.input_user_id is None and "input_user_id" in self.model_fields_set:
@@ -130,11 +122,6 @@ class ScoreEnsemble(BaseModel):
130
122
  "name": obj.get("name"),
131
123
  "type": obj.get("type") if obj.get("type") is not None else 'score_ensemble'
132
124
  })
133
- # store additional fields in additional_properties
134
- for _key in obj.keys():
135
- if _key not in cls.__properties:
136
- _obj.additional_properties[_key] = obj.get(_key)
137
-
138
125
  return _obj
139
126
 
140
127