shaped 2.0.4__py3-none-any.whl → 2.0.8__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 (291) hide show
  1. shaped/autogen/__init__.py +9 -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 +7 -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_index_config.py +89 -0
  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 +5 -6
  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 +5 -6
  60. shaped/autogen/models/entity_config.py +5 -6
  61. shaped/autogen/models/entity_journey.py +5 -6
  62. shaped/autogen/models/entity_type.py +5 -6
  63. shaped/autogen/models/evaluation_config.py +8 -7
  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 +5 -6
  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 +5 -6
  75. shaped/autogen/models/filter_table.py +5 -6
  76. shaped/autogen/models/filter_type.py +5 -6
  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 +5 -6
  84. shaped/autogen/models/iceberg_table_config.py +5 -6
  85. shaped/autogen/models/index_config.py +36 -8
  86. shaped/autogen/models/index_type.py +38 -0
  87. shaped/autogen/models/inner_entity_id.py +5 -6
  88. shaped/autogen/models/inner_size.py +5 -6
  89. shaped/autogen/models/inner_size1.py +5 -6
  90. shaped/autogen/models/inner_uid.py +5 -6
  91. shaped/autogen/models/interaction_config.py +5 -6
  92. shaped/autogen/models/interaction_pooling_encoder.py +5 -6
  93. shaped/autogen/models/interaction_round_robin_encoder.py +5 -6
  94. shaped/autogen/models/item_attribute_pooling_encoder.py +5 -6
  95. shaped/autogen/models/journey.py +5 -6
  96. shaped/autogen/models/kafka_table_config.py +5 -6
  97. shaped/autogen/models/kinesis_table_config.py +5 -6
  98. shaped/autogen/models/kinesis_table_config_column_schema_value.py +5 -6
  99. shaped/autogen/models/label.py +5 -6
  100. shaped/autogen/models/label_type.py +5 -6
  101. shaped/autogen/models/laplace_smoothing.py +5 -6
  102. shaped/autogen/models/latency_scaling_policy.py +5 -6
  103. shaped/autogen/models/learning_rate.py +5 -6
  104. shaped/autogen/models/learning_rate1.py +5 -6
  105. shaped/autogen/models/learning_rate2.py +5 -6
  106. shaped/autogen/models/learning_rate3.py +5 -6
  107. shaped/autogen/models/lexical_search_mode.py +5 -6
  108. shaped/autogen/models/list_engines_response.py +5 -6
  109. shaped/autogen/models/list_tables_response.py +5 -6
  110. shaped/autogen/models/list_views_response.py +5 -6
  111. shaped/autogen/models/location_inner.py +5 -6
  112. shaped/autogen/models/loss_types.py +5 -6
  113. shaped/autogen/models/lr.py +5 -6
  114. shaped/autogen/models/lr1.py +5 -6
  115. shaped/autogen/models/lr2.py +5 -6
  116. shaped/autogen/models/max_depth.py +5 -6
  117. shaped/autogen/models/max_leaves.py +5 -6
  118. shaped/autogen/models/max_seq_length.py +5 -6
  119. shaped/autogen/models/max_seq_length1.py +5 -6
  120. shaped/autogen/models/max_seq_length2.py +5 -6
  121. shaped/autogen/models/mode.py +5 -6
  122. shaped/autogen/models/mode1.py +5 -6
  123. shaped/autogen/models/models_inner.py +5 -6
  124. shaped/autogen/models/mongo_db_table_config.py +5 -6
  125. shaped/autogen/models/mssql_table_config.py +5 -6
  126. shaped/autogen/models/my_sql_table_config.py +5 -6
  127. shaped/autogen/models/n_epochs.py +5 -6
  128. shaped/autogen/models/n_epochs1.py +5 -6
  129. shaped/autogen/models/n_epochs2.py +5 -6
  130. shaped/autogen/models/n_estimators.py +5 -6
  131. shaped/autogen/models/n_heads.py +5 -6
  132. shaped/autogen/models/n_layers.py +5 -6
  133. shaped/autogen/models/neg_per_positive.py +5 -6
  134. shaped/autogen/models/negative_samples_count.py +5 -6
  135. shaped/autogen/models/ngram_tokenizer.py +5 -6
  136. shaped/autogen/models/no_op_config.py +5 -6
  137. shaped/autogen/models/num_blocks.py +5 -6
  138. shaped/autogen/models/num_heads.py +5 -6
  139. shaped/autogen/models/num_leaves.py +5 -6
  140. shaped/autogen/models/objective.py +5 -6
  141. shaped/autogen/models/objective1.py +5 -6
  142. shaped/autogen/models/online_store_config.py +5 -6
  143. shaped/autogen/models/pagination_config.py +5 -6
  144. shaped/autogen/models/parameter_definition.py +5 -6
  145. shaped/autogen/models/parameters_value.py +5 -6
  146. shaped/autogen/models/passthrough_score.py +5 -6
  147. shaped/autogen/models/personal_filter.py +5 -6
  148. shaped/autogen/models/pipeline_stage_explanation.py +5 -6
  149. shaped/autogen/models/policy.py +5 -6
  150. shaped/autogen/models/pooling_function.py +5 -6
  151. shaped/autogen/models/postgres_table_config.py +5 -6
  152. shaped/autogen/models/posthog_table_config.py +5 -6
  153. shaped/autogen/models/prebuilt_filter_step.py +5 -6
  154. shaped/autogen/models/precomputed_item_embedding.py +5 -6
  155. shaped/autogen/models/precomputed_user_embedding.py +5 -6
  156. shaped/autogen/models/query.py +5 -6
  157. shaped/autogen/models/query1.py +5 -6
  158. shaped/autogen/models/query_config.py +5 -6
  159. shaped/autogen/models/query_definition.py +5 -6
  160. shaped/autogen/models/query_encoder.py +5 -6
  161. shaped/autogen/models/query_explanation.py +5 -6
  162. shaped/autogen/models/query_request.py +5 -6
  163. shaped/autogen/models/query_result.py +5 -6
  164. shaped/autogen/models/query_table_config.py +5 -6
  165. shaped/autogen/models/rank_item_attribute_values_query_config.py +5 -6
  166. shaped/autogen/models/rank_query_config.py +5 -6
  167. shaped/autogen/models/rank_query_config_filter_inner.py +5 -6
  168. shaped/autogen/models/recreate_rollout.py +5 -6
  169. shaped/autogen/models/redshift_table_config.py +5 -6
  170. shaped/autogen/models/reference_table_config.py +5 -6
  171. shaped/autogen/models/regularization.py +5 -6
  172. shaped/autogen/models/reorder_inner.py +5 -6
  173. shaped/autogen/models/reorder_step_explanation.py +5 -6
  174. shaped/autogen/models/request.py +5 -6
  175. shaped/autogen/models/request1.py +5 -6
  176. shaped/autogen/models/requests_per_second_scaling_policy.py +5 -6
  177. shaped/autogen/models/resource_config.py +5 -6
  178. shaped/autogen/models/response_get_view_details_views_view_name_get.py +5 -6
  179. shaped/autogen/models/result.py +5 -6
  180. shaped/autogen/models/result_embeddings_value.py +5 -6
  181. shaped/autogen/models/retrieval_scores_value.py +5 -6
  182. shaped/autogen/models/retrieve_inner.py +5 -6
  183. shaped/autogen/models/retrieve_step_explanation.py +5 -6
  184. shaped/autogen/models/retriever.py +5 -6
  185. shaped/autogen/models/retriever1.py +5 -6
  186. shaped/autogen/models/rollout_config.py +5 -6
  187. shaped/autogen/models/rudderstack_table_config.py +5 -6
  188. shaped/autogen/models/sampling_strategy.py +5 -6
  189. shaped/autogen/models/saved_query_info_response.py +5 -6
  190. shaped/autogen/models/saved_query_list_response.py +5 -6
  191. shaped/autogen/models/saved_query_request.py +5 -6
  192. shaped/autogen/models/schema_config.py +5 -6
  193. shaped/autogen/models/score.py +5 -6
  194. shaped/autogen/models/score_ensemble.py +5 -6
  195. shaped/autogen/models/score_step_explanation.py +5 -6
  196. shaped/autogen/models/search_config.py +5 -6
  197. shaped/autogen/models/segment_table_config.py +5 -6
  198. shaped/autogen/models/sequence_length.py +5 -6
  199. shaped/autogen/models/server_config.py +5 -6
  200. shaped/autogen/models/setup_engine_response.py +5 -6
  201. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +5 -6
  202. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +5 -6
  203. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +5 -6
  204. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +5 -6
  205. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +5 -6
  206. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +5 -6
  207. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +5 -6
  208. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +5 -6
  209. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +5 -6
  210. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +5 -6
  211. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +5 -6
  212. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +5 -6
  213. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +5 -6
  214. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +5 -6
  215. shaped/autogen/models/shopify_table_config.py +5 -6
  216. shaped/autogen/models/similarity_retrieve_step.py +5 -6
  217. shaped/autogen/models/snowflake_table_config.py +5 -6
  218. shaped/autogen/models/sql_transform_type.py +5 -6
  219. shaped/autogen/models/sql_view_config.py +5 -6
  220. shaped/autogen/models/stemmer_tokenizer.py +5 -6
  221. shaped/autogen/models/step_explanation.py +5 -6
  222. shaped/autogen/models/steps_inner.py +5 -6
  223. shaped/autogen/models/strategy.py +5 -6
  224. shaped/autogen/models/table.py +5 -6
  225. shaped/autogen/models/table_deployment_type.py +5 -6
  226. shaped/autogen/models/table_insert_arguments.py +5 -6
  227. shaped/autogen/models/table_insert_response.py +5 -6
  228. shaped/autogen/models/text_search_retrieve_step.py +5 -6
  229. shaped/autogen/models/time_frequency.py +5 -6
  230. shaped/autogen/models/time_window.py +5 -6
  231. shaped/autogen/models/tokenizer.py +5 -6
  232. shaped/autogen/models/trained_model_encoder.py +5 -6
  233. shaped/autogen/models/training_compute_config.py +7 -10
  234. shaped/autogen/models/training_config.py +5 -6
  235. shaped/autogen/models/training_strategy.py +5 -6
  236. shaped/autogen/models/transform_status.py +5 -6
  237. shaped/autogen/models/truncate_filter_step.py +5 -6
  238. shaped/autogen/models/tunable_bool.py +5 -6
  239. shaped/autogen/models/tunable_float.py +5 -6
  240. shaped/autogen/models/tunable_int.py +5 -6
  241. shaped/autogen/models/tunable_int_categorical.py +5 -6
  242. shaped/autogen/models/tunable_string.py +5 -6
  243. shaped/autogen/models/tuning_config.py +5 -6
  244. shaped/autogen/models/update_table_response.py +5 -6
  245. shaped/autogen/models/update_view_response.py +5 -6
  246. shaped/autogen/models/user_attribute_pooling_encoder.py +5 -6
  247. shaped/autogen/models/user_inner.py +5 -6
  248. shaped/autogen/models/val_split.py +5 -6
  249. shaped/autogen/models/validation_error.py +5 -6
  250. shaped/autogen/models/value_type.py +5 -6
  251. shaped/autogen/models/vector_search_mode.py +5 -6
  252. shaped/autogen/models/view.py +5 -6
  253. shaped/autogen/models/view_details_ai.py +5 -6
  254. shaped/autogen/models/view_details_ai_schema_value.py +5 -6
  255. shaped/autogen/models/view_details_sql.py +5 -6
  256. shaped/autogen/models/weight_decay.py +5 -6
  257. shaped/autogen/models/whitespace_tokenizer.py +5 -6
  258. shaped/autogen/models/window_size.py +5 -6
  259. shaped/autogen/rest.py +5 -6
  260. {shaped-2.0.4.dist-info → shaped-2.0.8.dist-info}/METADATA +1 -1
  261. shaped-2.0.8.dist-info/RECORD +273 -0
  262. shaped/autogen/models/ascending.py +0 -148
  263. shaped/autogen/models/distance_function.py +0 -38
  264. shaped/autogen/models/encoding_pooling_strategy.py +0 -38
  265. shaped/autogen/models/engine_schema_user_inner.py +0 -146
  266. shaped/autogen/models/filter_dataset.py +0 -164
  267. shaped/autogen/models/mode2.py +0 -150
  268. shaped/autogen/models/pool_fn.py +0 -152
  269. shaped/autogen/models/query_any_of.py +0 -172
  270. shaped/autogen/models/rank_query_config_reorder_inner.py +0 -186
  271. shaped/autogen/models/rank_query_config_retrieve_inner.py +0 -265
  272. shaped/autogen/models/score_ensemble_policy_config.py +0 -165
  273. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +0 -755
  274. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +0 -156
  275. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +0 -195
  276. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +0 -161
  277. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +0 -108
  278. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +0 -143
  279. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +0 -153
  280. shaped/autogen/models/text_encoding.py +0 -148
  281. shaped/autogen/models/time_window_in_days.py +0 -154
  282. shaped/autogen/models/training_config_models_inner.py +0 -540
  283. shaped/autogen/models/trending_mode.py +0 -37
  284. shaped/autogen/models/type.py +0 -150
  285. shaped/autogen/models/validation_error_loc_inner.py +0 -150
  286. shaped/autogen/models/view_status.py +0 -41
  287. shaped-2.0.4.dist-info/RECORD +0 -296
  288. {shaped-2.0.4.dist-info → shaped-2.0.8.dist-info}/WHEEL +0 -0
  289. {shaped-2.0.4.dist-info → shaped-2.0.8.dist-info}/entry_points.txt +0 -0
  290. {shaped-2.0.4.dist-info → shaped-2.0.8.dist-info}/top_level.txt +0 -0
  291. {shaped-2.0.4.dist-info → shaped-2.0.8.dist-info}/zip-safe +0 -0
@@ -1,172 +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
- from typing import Any, Dict, Optional, Set, Union
20
-
21
- from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
22
- from shaped.autogen.models.rank_item_attribute_values_query_config import (
23
- RankItemAttributeValuesQueryConfig,
24
- )
25
- from shaped.autogen.models.rank_query_config import RankQueryConfig
26
- from typing_extensions import Self
27
-
28
- QUERYANYOF_ONE_OF_SCHEMAS = ["RankItemAttributeValuesQueryConfig", "RankQueryConfig"]
29
-
30
-
31
- class QueryAnyOf(BaseModel):
32
- """
33
- QueryAnyOf
34
- """
35
-
36
- # data type: RankQueryConfig
37
- oneof_schema_1_validator: Optional[RankQueryConfig] = None
38
- # data type: RankItemAttributeValuesQueryConfig
39
- oneof_schema_2_validator: Optional[RankItemAttributeValuesQueryConfig] = None
40
- actual_instance: Optional[
41
- Union[RankItemAttributeValuesQueryConfig, RankQueryConfig]
42
- ] = None
43
- one_of_schemas: Set[str] = {"RankItemAttributeValuesQueryConfig", "RankQueryConfig"}
44
-
45
- model_config = ConfigDict(
46
- validate_assignment=True,
47
- protected_namespaces=(),
48
- )
49
-
50
- discriminator_value_class_map: Dict[str, str] = {}
51
-
52
- def __init__(self, *args, **kwargs) -> None:
53
- if args:
54
- if len(args) > 1:
55
- raise ValueError(
56
- "If a position argument is used, only 1 is allowed to set `actual_instance`"
57
- )
58
- if kwargs:
59
- raise ValueError(
60
- "If a position argument is used, keyword arguments cannot be used."
61
- )
62
- super().__init__(actual_instance=args[0])
63
- else:
64
- super().__init__(**kwargs)
65
-
66
- @field_validator("actual_instance")
67
- def actual_instance_must_validate_oneof(cls, v):
68
- instance = QueryAnyOf.model_construct()
69
- error_messages = []
70
- match = 0
71
- # validate data type: RankQueryConfig
72
- if not isinstance(v, RankQueryConfig):
73
- error_messages.append(
74
- f"Error! Input type `{type(v)}` is not `RankQueryConfig`"
75
- )
76
- else:
77
- match += 1
78
- # validate data type: RankItemAttributeValuesQueryConfig
79
- if not isinstance(v, RankItemAttributeValuesQueryConfig):
80
- error_messages.append(
81
- f"Error! Input type `{type(v)}` is not `RankItemAttributeValuesQueryConfig`"
82
- )
83
- else:
84
- match += 1
85
- if match > 1:
86
- # more than 1 match
87
- raise ValueError(
88
- "Multiple matches found when setting `actual_instance` in QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
89
- + ", ".join(error_messages)
90
- )
91
- elif match == 0:
92
- # no match
93
- raise ValueError(
94
- "No match found when setting `actual_instance` in QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
95
- + ", ".join(error_messages)
96
- )
97
- else:
98
- return v
99
-
100
- @classmethod
101
- def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
102
- return cls.from_json(json.dumps(obj))
103
-
104
- @classmethod
105
- def from_json(cls, json_str: str) -> Self:
106
- """Returns the object represented by the json string"""
107
- instance = cls.model_construct()
108
- error_messages = []
109
- match = 0
110
-
111
- # deserialize data into RankQueryConfig
112
- try:
113
- instance.actual_instance = RankQueryConfig.from_json(json_str)
114
- match += 1
115
- except (ValidationError, ValueError) as e:
116
- error_messages.append(str(e))
117
- # deserialize data into RankItemAttributeValuesQueryConfig
118
- try:
119
- instance.actual_instance = RankItemAttributeValuesQueryConfig.from_json(
120
- json_str
121
- )
122
- match += 1
123
- except (ValidationError, ValueError) as e:
124
- error_messages.append(str(e))
125
-
126
- if match > 1:
127
- # more than 1 match
128
- raise ValueError(
129
- "Multiple matches found when deserializing the JSON string into QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
130
- + ", ".join(error_messages)
131
- )
132
- elif match == 0:
133
- # no match
134
- raise ValueError(
135
- "No match found when deserializing the JSON string into QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
136
- + ", ".join(error_messages)
137
- )
138
- else:
139
- return instance
140
-
141
- def to_json(self) -> str:
142
- """Returns the JSON representation of the actual instance"""
143
- if self.actual_instance is None:
144
- return "null"
145
-
146
- if hasattr(self.actual_instance, "to_json") and callable(
147
- self.actual_instance.to_json
148
- ):
149
- return self.actual_instance.to_json()
150
- else:
151
- return json.dumps(self.actual_instance)
152
-
153
- def to_dict(
154
- self,
155
- ) -> Optional[
156
- Union[Dict[str, Any], RankItemAttributeValuesQueryConfig, RankQueryConfig]
157
- ]:
158
- """Returns the dict representation of the actual instance"""
159
- if self.actual_instance is None:
160
- return None
161
-
162
- if hasattr(self.actual_instance, "to_dict") and callable(
163
- self.actual_instance.to_dict
164
- ):
165
- return self.actual_instance.to_dict()
166
- else:
167
- # primitive type
168
- return self.actual_instance
169
-
170
- def to_str(self) -> str:
171
- """Returns the string representation of the actual instance"""
172
- return pprint.pformat(self.model_dump())
@@ -1,186 +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 TYPE_CHECKING, Any, Dict, Optional, Set, Union
21
-
22
- from pydantic import BaseModel, ValidationError, field_validator
23
- from shaped.autogen.models.boosted_reorder_step import BoostedReorderStep
24
- from shaped.autogen.models.diversity_reorder_step import DiversityReorderStep
25
- from shaped.autogen.models.exploration_reorder_step import ExplorationReorderStep
26
- from typing_extensions import Self
27
-
28
- RANKQUERYCONFIGREORDERINNER_ANY_OF_SCHEMAS = [
29
- "BoostedReorderStep",
30
- "DiversityReorderStep",
31
- "ExplorationReorderStep",
32
- ]
33
-
34
-
35
- class RankQueryConfigReorderInner(BaseModel):
36
- """
37
- RankQueryConfigReorderInner
38
- """
39
-
40
- # data type: ExplorationReorderStep
41
- anyof_schema_1_validator: Optional[ExplorationReorderStep] = None
42
- # data type: BoostedReorderStep
43
- anyof_schema_2_validator: Optional[BoostedReorderStep] = None
44
- # data type: DiversityReorderStep
45
- anyof_schema_3_validator: Optional[DiversityReorderStep] = None
46
- if TYPE_CHECKING:
47
- actual_instance: Optional[
48
- Union[BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep]
49
- ] = None
50
- else:
51
- actual_instance: Any = None
52
- any_of_schemas: Set[str] = {
53
- "BoostedReorderStep",
54
- "DiversityReorderStep",
55
- "ExplorationReorderStep",
56
- }
57
-
58
- model_config = {
59
- "validate_assignment": True,
60
- "protected_namespaces": (),
61
- }
62
-
63
- def __init__(self, *args, **kwargs) -> None:
64
- if args:
65
- if len(args) > 1:
66
- raise ValueError(
67
- "If a position argument is used, only 1 is allowed to set `actual_instance`"
68
- )
69
- if kwargs:
70
- raise ValueError(
71
- "If a position argument is used, keyword arguments cannot be used."
72
- )
73
- super().__init__(actual_instance=args[0])
74
- else:
75
- super().__init__(**kwargs)
76
-
77
- @field_validator("actual_instance")
78
- def actual_instance_must_validate_anyof(cls, v):
79
- instance = RankQueryConfigReorderInner.model_construct()
80
- error_messages = []
81
- # validate data type: ExplorationReorderStep
82
- if not isinstance(v, ExplorationReorderStep):
83
- error_messages.append(
84
- f"Error! Input type `{type(v)}` is not `ExplorationReorderStep`"
85
- )
86
- else:
87
- return v
88
-
89
- # validate data type: BoostedReorderStep
90
- if not isinstance(v, BoostedReorderStep):
91
- error_messages.append(
92
- f"Error! Input type `{type(v)}` is not `BoostedReorderStep`"
93
- )
94
- else:
95
- return v
96
-
97
- # validate data type: DiversityReorderStep
98
- if not isinstance(v, DiversityReorderStep):
99
- error_messages.append(
100
- f"Error! Input type `{type(v)}` is not `DiversityReorderStep`"
101
- )
102
- else:
103
- return v
104
-
105
- if error_messages:
106
- # no match
107
- raise ValueError(
108
- "No match found when setting the actual_instance in RankQueryConfigReorderInner with anyOf schemas: BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep. Details: "
109
- + ", ".join(error_messages)
110
- )
111
- else:
112
- return v
113
-
114
- @classmethod
115
- def from_dict(cls, obj: 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
- # anyof_schema_1_validator: Optional[ExplorationReorderStep] = None
124
- try:
125
- instance.actual_instance = ExplorationReorderStep.from_json(json_str)
126
- return instance
127
- except (ValidationError, ValueError) as e:
128
- error_messages.append(str(e))
129
- # anyof_schema_2_validator: Optional[BoostedReorderStep] = None
130
- try:
131
- instance.actual_instance = BoostedReorderStep.from_json(json_str)
132
- return instance
133
- except (ValidationError, ValueError) as e:
134
- error_messages.append(str(e))
135
- # anyof_schema_3_validator: Optional[DiversityReorderStep] = None
136
- try:
137
- instance.actual_instance = DiversityReorderStep.from_json(json_str)
138
- return instance
139
- except (ValidationError, ValueError) as e:
140
- error_messages.append(str(e))
141
-
142
- if error_messages:
143
- # no match
144
- raise ValueError(
145
- "No match found when deserializing the JSON string into RankQueryConfigReorderInner with anyOf schemas: BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep. Details: "
146
- + ", ".join(error_messages)
147
- )
148
- else:
149
- return instance
150
-
151
- def to_json(self) -> str:
152
- """Returns the JSON representation of the actual instance"""
153
- if self.actual_instance is None:
154
- return "null"
155
-
156
- if hasattr(self.actual_instance, "to_json") and callable(
157
- self.actual_instance.to_json
158
- ):
159
- return self.actual_instance.to_json()
160
- else:
161
- return json.dumps(self.actual_instance)
162
-
163
- def to_dict(
164
- self,
165
- ) -> Optional[
166
- Union[
167
- Dict[str, Any],
168
- BoostedReorderStep,
169
- DiversityReorderStep,
170
- ExplorationReorderStep,
171
- ]
172
- ]:
173
- """Returns the dict representation of the actual instance"""
174
- if self.actual_instance is None:
175
- return None
176
-
177
- if hasattr(self.actual_instance, "to_dict") and callable(
178
- self.actual_instance.to_dict
179
- ):
180
- return self.actual_instance.to_dict()
181
- else:
182
- return self.actual_instance
183
-
184
- def to_str(self) -> str:
185
- """Returns the string representation of the actual instance"""
186
- return pprint.pformat(self.model_dump())
@@ -1,265 +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
- from typing import Any, Dict, Optional, Set, Union
20
-
21
- from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
22
- from shaped.autogen.models.candidate_attributes_retrieve_step import (
23
- CandidateAttributesRetrieveStep,
24
- )
25
- from shaped.autogen.models.candidate_ids_retrieve_step import CandidateIdsRetrieveStep
26
- from shaped.autogen.models.column_order_retrieve_step import ColumnOrderRetrieveStep
27
- from shaped.autogen.models.filter_retrieve_step import FilterRetrieveStep
28
- from shaped.autogen.models.similarity_retrieve_step import SimilarityRetrieveStep
29
- from shaped.autogen.models.text_search_retrieve_step import TextSearchRetrieveStep
30
- from typing_extensions import Self
31
-
32
- RANKQUERYCONFIGRETRIEVEINNER_ONE_OF_SCHEMAS = [
33
- "CandidateAttributesRetrieveStep",
34
- "CandidateIdsRetrieveStep",
35
- "ColumnOrderRetrieveStep",
36
- "FilterRetrieveStep",
37
- "SimilarityRetrieveStep",
38
- "TextSearchRetrieveStep",
39
- ]
40
-
41
-
42
- class RankQueryConfigRetrieveInner(BaseModel):
43
- """
44
- RankQueryConfigRetrieveInner
45
- """
46
-
47
- # data type: ColumnOrderRetrieveStep
48
- oneof_schema_1_validator: Optional[ColumnOrderRetrieveStep] = None
49
- # data type: TextSearchRetrieveStep
50
- oneof_schema_2_validator: Optional[TextSearchRetrieveStep] = None
51
- # data type: SimilarityRetrieveStep
52
- oneof_schema_3_validator: Optional[SimilarityRetrieveStep] = None
53
- # data type: FilterRetrieveStep
54
- oneof_schema_4_validator: Optional[FilterRetrieveStep] = None
55
- # data type: CandidateIdsRetrieveStep
56
- oneof_schema_5_validator: Optional[CandidateIdsRetrieveStep] = None
57
- # data type: CandidateAttributesRetrieveStep
58
- oneof_schema_6_validator: Optional[CandidateAttributesRetrieveStep] = None
59
- actual_instance: Optional[
60
- Union[
61
- CandidateAttributesRetrieveStep,
62
- CandidateIdsRetrieveStep,
63
- ColumnOrderRetrieveStep,
64
- FilterRetrieveStep,
65
- SimilarityRetrieveStep,
66
- TextSearchRetrieveStep,
67
- ]
68
- ] = None
69
- one_of_schemas: Set[str] = {
70
- "CandidateAttributesRetrieveStep",
71
- "CandidateIdsRetrieveStep",
72
- "ColumnOrderRetrieveStep",
73
- "FilterRetrieveStep",
74
- "SimilarityRetrieveStep",
75
- "TextSearchRetrieveStep",
76
- }
77
-
78
- model_config = ConfigDict(
79
- validate_assignment=True,
80
- protected_namespaces=(),
81
- )
82
-
83
- discriminator_value_class_map: Dict[str, str] = {}
84
-
85
- def __init__(self, *args, **kwargs) -> None:
86
- if args:
87
- if len(args) > 1:
88
- raise ValueError(
89
- "If a position argument is used, only 1 is allowed to set `actual_instance`"
90
- )
91
- if kwargs:
92
- raise ValueError(
93
- "If a position argument is used, keyword arguments cannot be used."
94
- )
95
- super().__init__(actual_instance=args[0])
96
- else:
97
- super().__init__(**kwargs)
98
-
99
- @field_validator("actual_instance")
100
- def actual_instance_must_validate_oneof(cls, v):
101
- instance = RankQueryConfigRetrieveInner.model_construct()
102
- error_messages = []
103
- match = 0
104
- # validate data type: ColumnOrderRetrieveStep
105
- if not isinstance(v, ColumnOrderRetrieveStep):
106
- error_messages.append(
107
- f"Error! Input type `{type(v)}` is not `ColumnOrderRetrieveStep`"
108
- )
109
- else:
110
- match += 1
111
- # validate data type: TextSearchRetrieveStep
112
- if not isinstance(v, TextSearchRetrieveStep):
113
- error_messages.append(
114
- f"Error! Input type `{type(v)}` is not `TextSearchRetrieveStep`"
115
- )
116
- else:
117
- match += 1
118
- # validate data type: SimilarityRetrieveStep
119
- if not isinstance(v, SimilarityRetrieveStep):
120
- error_messages.append(
121
- f"Error! Input type `{type(v)}` is not `SimilarityRetrieveStep`"
122
- )
123
- else:
124
- match += 1
125
- # validate data type: FilterRetrieveStep
126
- if not isinstance(v, FilterRetrieveStep):
127
- error_messages.append(
128
- f"Error! Input type `{type(v)}` is not `FilterRetrieveStep`"
129
- )
130
- else:
131
- match += 1
132
- # validate data type: CandidateIdsRetrieveStep
133
- if not isinstance(v, CandidateIdsRetrieveStep):
134
- error_messages.append(
135
- f"Error! Input type `{type(v)}` is not `CandidateIdsRetrieveStep`"
136
- )
137
- else:
138
- match += 1
139
- # validate data type: CandidateAttributesRetrieveStep
140
- if not isinstance(v, CandidateAttributesRetrieveStep):
141
- error_messages.append(
142
- f"Error! Input type `{type(v)}` is not `CandidateAttributesRetrieveStep`"
143
- )
144
- else:
145
- match += 1
146
- if match > 1:
147
- # more than 1 match
148
- raise ValueError(
149
- "Multiple matches found when setting `actual_instance` in RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: "
150
- + ", ".join(error_messages)
151
- )
152
- elif match == 0:
153
- # no match
154
- raise ValueError(
155
- "No match found when setting `actual_instance` in RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: "
156
- + ", ".join(error_messages)
157
- )
158
- else:
159
- return v
160
-
161
- @classmethod
162
- def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
163
- return cls.from_json(json.dumps(obj))
164
-
165
- @classmethod
166
- def from_json(cls, json_str: str) -> Self:
167
- """Returns the object represented by the json string"""
168
- instance = cls.model_construct()
169
- error_messages = []
170
- match = 0
171
-
172
- # deserialize data into ColumnOrderRetrieveStep
173
- try:
174
- instance.actual_instance = ColumnOrderRetrieveStep.from_json(json_str)
175
- match += 1
176
- except (ValidationError, ValueError) as e:
177
- error_messages.append(str(e))
178
- # deserialize data into TextSearchRetrieveStep
179
- try:
180
- instance.actual_instance = TextSearchRetrieveStep.from_json(json_str)
181
- match += 1
182
- except (ValidationError, ValueError) as e:
183
- error_messages.append(str(e))
184
- # deserialize data into SimilarityRetrieveStep
185
- try:
186
- instance.actual_instance = SimilarityRetrieveStep.from_json(json_str)
187
- match += 1
188
- except (ValidationError, ValueError) as e:
189
- error_messages.append(str(e))
190
- # deserialize data into FilterRetrieveStep
191
- try:
192
- instance.actual_instance = FilterRetrieveStep.from_json(json_str)
193
- match += 1
194
- except (ValidationError, ValueError) as e:
195
- error_messages.append(str(e))
196
- # deserialize data into CandidateIdsRetrieveStep
197
- try:
198
- instance.actual_instance = CandidateIdsRetrieveStep.from_json(json_str)
199
- match += 1
200
- except (ValidationError, ValueError) as e:
201
- error_messages.append(str(e))
202
- # deserialize data into CandidateAttributesRetrieveStep
203
- try:
204
- instance.actual_instance = CandidateAttributesRetrieveStep.from_json(
205
- json_str
206
- )
207
- match += 1
208
- except (ValidationError, ValueError) as e:
209
- error_messages.append(str(e))
210
-
211
- if match > 1:
212
- # more than 1 match
213
- raise ValueError(
214
- "Multiple matches found when deserializing the JSON string into RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: "
215
- + ", ".join(error_messages)
216
- )
217
- elif match == 0:
218
- # no match
219
- raise ValueError(
220
- "No match found when deserializing the JSON string into RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: "
221
- + ", ".join(error_messages)
222
- )
223
- else:
224
- return instance
225
-
226
- def to_json(self) -> str:
227
- """Returns the JSON representation of the actual instance"""
228
- if self.actual_instance is None:
229
- return "null"
230
-
231
- if hasattr(self.actual_instance, "to_json") and callable(
232
- self.actual_instance.to_json
233
- ):
234
- return self.actual_instance.to_json()
235
- else:
236
- return json.dumps(self.actual_instance)
237
-
238
- def to_dict(
239
- self,
240
- ) -> Optional[
241
- Union[
242
- Dict[str, Any],
243
- CandidateAttributesRetrieveStep,
244
- CandidateIdsRetrieveStep,
245
- ColumnOrderRetrieveStep,
246
- FilterRetrieveStep,
247
- SimilarityRetrieveStep,
248
- TextSearchRetrieveStep,
249
- ]
250
- ]:
251
- """Returns the dict representation of the actual instance"""
252
- if self.actual_instance is None:
253
- return None
254
-
255
- if hasattr(self.actual_instance, "to_dict") and callable(
256
- self.actual_instance.to_dict
257
- ):
258
- return self.actual_instance.to_dict()
259
- else:
260
- # primitive type
261
- return self.actual_instance
262
-
263
- def to_str(self) -> str:
264
- """Returns the string representation of the actual instance"""
265
- return pprint.pformat(self.model_dump())