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