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
@@ -1,134 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Shaped API
5
-
6
- Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
-
8
- The version of the OpenAPI document: 2.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
-
15
- from __future__ import annotations
16
- from inspect import getfullargspec
17
- import json
18
- import pprint
19
- import re # noqa: F401
20
- from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
21
- from typing import Optional
22
- from shaped.autogen.models.encoding_pooling_strategy import EncodingPoolingStrategy
23
- from shaped.autogen.models.tunable_string import TunableString
24
- from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
25
- from typing_extensions import Literal, Self
26
- from pydantic import Field
27
-
28
- POOLFN_ANY_OF_SCHEMAS = ["EncodingPoolingStrategy", "TunableString"]
29
-
30
- class PoolFn(BaseModel):
31
- """
32
- PoolFn
33
- """
34
-
35
- # data type: EncodingPoolingStrategy
36
- anyof_schema_1_validator: Optional[EncodingPoolingStrategy] = None
37
- # data type: TunableString
38
- anyof_schema_2_validator: Optional[TunableString] = None
39
- if TYPE_CHECKING:
40
- actual_instance: Optional[Union[EncodingPoolingStrategy, TunableString]] = None
41
- else:
42
- actual_instance: Any = None
43
- any_of_schemas: Set[str] = { "EncodingPoolingStrategy", "TunableString" }
44
-
45
- model_config = {
46
- "validate_assignment": True,
47
- "protected_namespaces": (),
48
- }
49
-
50
- def __init__(self, *args, **kwargs) -> None:
51
- if args:
52
- if len(args) > 1:
53
- raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
54
- if kwargs:
55
- raise ValueError("If a position argument is used, keyword arguments cannot be used.")
56
- super().__init__(actual_instance=args[0])
57
- else:
58
- super().__init__(**kwargs)
59
-
60
- @field_validator('actual_instance')
61
- def actual_instance_must_validate_anyof(cls, v):
62
- instance = PoolFn.model_construct()
63
- error_messages = []
64
- # validate data type: EncodingPoolingStrategy
65
- if not isinstance(v, EncodingPoolingStrategy):
66
- error_messages.append(f"Error! Input type `{type(v)}` is not `EncodingPoolingStrategy`")
67
- else:
68
- return v
69
-
70
- # validate data type: TunableString
71
- if not isinstance(v, TunableString):
72
- error_messages.append(f"Error! Input type `{type(v)}` is not `TunableString`")
73
- else:
74
- return v
75
-
76
- if error_messages:
77
- # no match
78
- raise ValueError("No match found when setting the actual_instance in PoolFn with anyOf schemas: EncodingPoolingStrategy, TunableString. Details: " + ", ".join(error_messages))
79
- else:
80
- return v
81
-
82
- @classmethod
83
- def from_dict(cls, obj: Dict[str, Any]) -> Self:
84
- return cls.from_json(json.dumps(obj))
85
-
86
- @classmethod
87
- def from_json(cls, json_str: str) -> Self:
88
- """Returns the object represented by the json string"""
89
- instance = cls.model_construct()
90
- error_messages = []
91
- # anyof_schema_1_validator: Optional[EncodingPoolingStrategy] = None
92
- try:
93
- instance.actual_instance = EncodingPoolingStrategy.from_json(json_str)
94
- return instance
95
- except (ValidationError, ValueError) as e:
96
- error_messages.append(str(e))
97
- # anyof_schema_2_validator: Optional[TunableString] = None
98
- try:
99
- instance.actual_instance = TunableString.from_json(json_str)
100
- return instance
101
- except (ValidationError, ValueError) as e:
102
- error_messages.append(str(e))
103
-
104
- if error_messages:
105
- # no match
106
- raise ValueError("No match found when deserializing the JSON string into PoolFn with anyOf schemas: EncodingPoolingStrategy, TunableString. Details: " + ", ".join(error_messages))
107
- else:
108
- return instance
109
-
110
- def to_json(self) -> str:
111
- """Returns the JSON representation of the actual instance"""
112
- if self.actual_instance is None:
113
- return "null"
114
-
115
- if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
116
- return self.actual_instance.to_json()
117
- else:
118
- return json.dumps(self.actual_instance)
119
-
120
- def to_dict(self) -> Optional[Union[Dict[str, Any], EncodingPoolingStrategy, TunableString]]:
121
- """Returns the dict representation of the actual instance"""
122
- if self.actual_instance is None:
123
- return None
124
-
125
- if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
126
- return self.actual_instance.to_dict()
127
- else:
128
- return self.actual_instance
129
-
130
- def to_str(self) -> str:
131
- """Returns the string representation of the actual instance"""
132
- return pprint.pformat(self.model_dump())
133
-
134
-
@@ -1,141 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Shaped API
5
-
6
- Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
-
8
- The version of the OpenAPI document: 2.0.0
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
-
15
- from __future__ import annotations
16
- import pprint
17
- import re # noqa: F401
18
- import json
19
-
20
- from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
21
- from typing import Any, ClassVar, Dict, List, Optional
22
- from typing import Optional, Set
23
- from typing_extensions import Self
24
-
25
- class ScoreEnsemblePolicyConfig(BaseModel):
26
- """
27
- Configuration for ScoreEnsemblePolicy. This policy combines multiple scoring policies using a value model to determine the final scores.
28
- """ # noqa: E501
29
- policy_type: Optional[StrictStr] = 'score-ensemble'
30
- name: Optional[StrictStr] = None
31
- policies: Optional[List[ScoreEnsemblePolicyConfigPoliciesInner]] = None
32
- value_model: Optional[StrictStr] = None
33
- additional_properties: Dict[str, Any] = {}
34
- __properties: ClassVar[List[str]] = ["policy_type", "name", "policies", "value_model"]
35
-
36
- @field_validator('policy_type')
37
- def policy_type_validate_enum(cls, value):
38
- """Validates the enum"""
39
- if value is None:
40
- return value
41
-
42
- if value not in set(['score-ensemble']):
43
- raise ValueError("must be one of enum values ('score-ensemble')")
44
- return value
45
-
46
- model_config = ConfigDict(
47
- populate_by_name=True,
48
- validate_assignment=True,
49
- protected_namespaces=(),
50
- )
51
-
52
-
53
- def to_str(self) -> str:
54
- """Returns the string representation of the model using alias"""
55
- return pprint.pformat(self.model_dump(by_alias=True))
56
-
57
- def to_json(self) -> str:
58
- """Returns the JSON representation of the model using alias"""
59
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
60
- return json.dumps(self.to_dict())
61
-
62
- @classmethod
63
- def from_json(cls, json_str: str) -> Optional[Self]:
64
- """Create an instance of ScoreEnsemblePolicyConfig from a JSON string"""
65
- return cls.from_dict(json.loads(json_str))
66
-
67
- def to_dict(self) -> Dict[str, Any]:
68
- """Return the dictionary representation of the model using alias.
69
-
70
- This has the following differences from calling pydantic's
71
- `self.model_dump(by_alias=True)`:
72
-
73
- * `None` is only added to the output dict for nullable fields that
74
- were set at model initialization. Other fields with value `None`
75
- are ignored.
76
- * Fields in `self.additional_properties` are added to the output dict.
77
- """
78
- excluded_fields: Set[str] = set([
79
- "additional_properties",
80
- ])
81
-
82
- _dict = self.model_dump(
83
- by_alias=True,
84
- exclude=excluded_fields,
85
- exclude_none=True,
86
- )
87
- # override the default output from pydantic by calling `to_dict()` of each item in policies (list)
88
- _items = []
89
- if self.policies:
90
- for _item_policies in self.policies:
91
- if _item_policies:
92
- _items.append(_item_policies.to_dict())
93
- _dict['policies'] = _items
94
- # puts key-value pairs in additional_properties in the top level
95
- if self.additional_properties is not None:
96
- for _key, _value in self.additional_properties.items():
97
- _dict[_key] = _value
98
-
99
- # set to None if name (nullable) is None
100
- # and model_fields_set contains the field
101
- if self.name is None and "name" in self.model_fields_set:
102
- _dict['name'] = None
103
-
104
- # set to None if policies (nullable) is None
105
- # and model_fields_set contains the field
106
- if self.policies is None and "policies" in self.model_fields_set:
107
- _dict['policies'] = None
108
-
109
- # set to None if value_model (nullable) is None
110
- # and model_fields_set contains the field
111
- if self.value_model is None and "value_model" in self.model_fields_set:
112
- _dict['value_model'] = None
113
-
114
- return _dict
115
-
116
- @classmethod
117
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
118
- """Create an instance of ScoreEnsemblePolicyConfig from a dict"""
119
- if obj is None:
120
- return None
121
-
122
- if not isinstance(obj, dict):
123
- return cls.model_validate(obj)
124
-
125
- _obj = cls.model_validate({
126
- "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'score-ensemble',
127
- "name": obj.get("name"),
128
- "policies": [ScoreEnsemblePolicyConfigPoliciesInner.from_dict(_item) for _item in obj["policies"]] if obj.get("policies") is not None else None,
129
- "value_model": obj.get("value_model")
130
- })
131
- # store additional fields in additional_properties
132
- for _key in obj.keys():
133
- if _key not in cls.__properties:
134
- _obj.additional_properties[_key] = obj.get(_key)
135
-
136
- return _obj
137
-
138
- from shaped.autogen.models.score_ensemble_policy_config_policies_inner import ScoreEnsemblePolicyConfigPoliciesInner
139
- # TODO: Rewrite to not use raise_errors
140
- ScoreEnsemblePolicyConfig.model_rebuild(raise_errors=False)
141
-