shaped 2.0.2__py3-none-any.whl → 2.0.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (294) hide show
  1. shaped/__init__.py +47 -42
  2. shaped/autogen/__init__.py +37 -51
  3. shaped/autogen/api/engine_api.py +1 -1
  4. shaped/autogen/api/query_api.py +8 -68
  5. shaped/autogen/api/table_api.py +1 -1
  6. shaped/autogen/api/view_api.py +1 -1
  7. shaped/autogen/api_client.py +4 -4
  8. shaped/autogen/configuration.py +5 -3
  9. shaped/autogen/exceptions.py +7 -4
  10. shaped/autogen/models/__init__.py +19 -26
  11. shaped/autogen/models/ai_enrichment_view_config.py +1 -1
  12. shaped/autogen/models/algorithm.py +1 -1
  13. shaped/autogen/models/amplitude_table_config.py +1 -1
  14. shaped/autogen/models/ascending.py +29 -17
  15. shaped/autogen/models/attn_dropout_prob.py +1 -1
  16. shaped/autogen/models/attribute_journey.py +1 -1
  17. shaped/autogen/models/attribute_value.py +1 -1
  18. shaped/autogen/models/autoscaling_config.py +1 -1
  19. shaped/autogen/models/aws_pinpoint_table_config.py +1 -1
  20. shaped/autogen/models/batch_size.py +1 -1
  21. shaped/autogen/models/batch_size1.py +1 -1
  22. shaped/autogen/models/batch_size2.py +1 -1
  23. shaped/autogen/models/big_query_table_config.py +1 -1
  24. shaped/autogen/models/bm25.py +1 -1
  25. shaped/autogen/models/boosted_reorder_step.py +1 -1
  26. shaped/autogen/models/canary_rollout.py +1 -1
  27. shaped/autogen/models/candidate_attributes_retrieve_step.py +1 -14
  28. shaped/autogen/models/candidate_ids_retrieve_step.py +1 -1
  29. shaped/autogen/models/candidate_retrieval_strategy.py +1 -1
  30. shaped/autogen/models/clickhouse_table_config.py +1 -1
  31. shaped/autogen/models/column_order_retrieve_step.py +1 -1
  32. shaped/autogen/models/column_ordering.py +1 -1
  33. shaped/autogen/models/create_table_response.py +1 -1
  34. shaped/autogen/models/create_view_response.py +1 -1
  35. shaped/autogen/models/custom_table_config.py +1 -1
  36. shaped/autogen/models/data_compute_config.py +1 -1
  37. shaped/autogen/models/data_config.py +1 -1
  38. shaped/autogen/models/data_config_interaction_table.py +1 -1
  39. shaped/autogen/models/data_split_config.py +1 -1
  40. shaped/autogen/models/data_split_strategy.py +1 -1
  41. shaped/autogen/models/data_tier.py +1 -1
  42. shaped/autogen/models/default.py +1 -1
  43. shaped/autogen/models/delete_engine_response.py +1 -1
  44. shaped/autogen/models/delete_table_response.py +1 -1
  45. shaped/autogen/models/delete_view_response.py +1 -1
  46. shaped/autogen/models/deployment_config.py +2 -8
  47. shaped/autogen/models/distance_function.py +5 -5
  48. shaped/autogen/models/diversity_reorder_step.py +1 -1
  49. shaped/autogen/models/dropout_rate.py +1 -1
  50. shaped/autogen/models/dynamo_db_table_config.py +1 -1
  51. shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +1 -1
  52. shaped/autogen/models/embedder_batch_size.py +1 -1
  53. shaped/autogen/models/embedding_config.py +1 -1
  54. shaped/autogen/models/embedding_dim.py +1 -1
  55. shaped/autogen/models/embedding_dims.py +1 -1
  56. shaped/autogen/models/embedding_size.py +1 -1
  57. shaped/autogen/models/encoder.py +1 -1
  58. shaped/autogen/models/encoding_pooling_strategy.py +5 -5
  59. shaped/autogen/models/engine.py +1 -1
  60. shaped/autogen/models/engine_config_v2.py +1 -1
  61. shaped/autogen/models/engine_details_response.py +1 -1
  62. shaped/autogen/models/engine_schema.py +8 -8
  63. shaped/autogen/models/engine_schema_user_inner.py +30 -18
  64. shaped/autogen/models/entity_config.py +1 -1
  65. shaped/autogen/models/entity_journey.py +28 -19
  66. shaped/autogen/models/entity_type.py +1 -1
  67. shaped/autogen/models/evaluation_config.py +1 -1
  68. shaped/autogen/models/exploration_reorder_step.py +1 -1
  69. shaped/autogen/models/expression_filter_step.py +1 -1
  70. shaped/autogen/models/factors.py +1 -1
  71. shaped/autogen/models/factors1.py +1 -1
  72. shaped/autogen/models/feature.py +1 -1
  73. shaped/autogen/models/feature_type.py +1 -1
  74. shaped/autogen/models/file_table_config.py +1 -1
  75. shaped/autogen/models/filter_config.py +14 -14
  76. shaped/autogen/models/filter_dataset.py +47 -23
  77. shaped/autogen/models/filter_index_type.py +1 -1
  78. shaped/autogen/models/filter_retrieve_step.py +1 -1
  79. shaped/autogen/models/filter_step_explanation.py +165 -0
  80. shaped/autogen/models/filter_table.py +140 -0
  81. shaped/autogen/models/filter_type.py +134 -0
  82. shaped/autogen/models/global_filter.py +1 -1
  83. shaped/autogen/models/hidden_dropout_prob.py +1 -1
  84. shaped/autogen/models/hidden_size.py +1 -1
  85. shaped/autogen/models/hidden_size1.py +1 -1
  86. shaped/autogen/models/http_problem_response.py +1 -1
  87. shaped/autogen/models/http_validation_error.py +1 -1
  88. shaped/autogen/models/hugging_face_encoder.py +6 -4
  89. shaped/autogen/models/iceberg_table_config.py +1 -1
  90. shaped/autogen/models/index_config.py +1 -1
  91. shaped/autogen/models/inner_entity_id.py +144 -0
  92. shaped/autogen/models/inner_size.py +1 -1
  93. shaped/autogen/models/inner_size1.py +1 -1
  94. shaped/autogen/models/inner_uid.py +144 -0
  95. shaped/autogen/models/interaction_config.py +1 -1
  96. shaped/autogen/models/interaction_pooling_encoder.py +1 -1
  97. shaped/autogen/models/interaction_round_robin_encoder.py +1 -1
  98. shaped/autogen/models/item_attribute_pooling_encoder.py +1 -14
  99. shaped/autogen/models/journey.py +1 -1
  100. shaped/autogen/models/kafka_table_config.py +1 -1
  101. shaped/autogen/models/kinesis_table_config.py +1 -1
  102. shaped/autogen/models/kinesis_table_config_column_schema_value.py +1 -1
  103. shaped/autogen/models/label.py +1 -1
  104. shaped/autogen/models/label_type.py +1 -2
  105. shaped/autogen/models/laplace_smoothing.py +1 -1
  106. shaped/autogen/models/latency_scaling_policy.py +1 -1
  107. shaped/autogen/models/learning_rate.py +1 -1
  108. shaped/autogen/models/learning_rate1.py +1 -1
  109. shaped/autogen/models/learning_rate2.py +1 -1
  110. shaped/autogen/models/learning_rate3.py +1 -1
  111. shaped/autogen/models/lexical_search_mode.py +3 -3
  112. shaped/autogen/models/list_engines_response.py +1 -1
  113. shaped/autogen/models/list_tables_response.py +1 -1
  114. shaped/autogen/models/list_views_response.py +1 -1
  115. shaped/autogen/models/location_inner.py +138 -0
  116. shaped/autogen/models/loss_types.py +1 -1
  117. shaped/autogen/models/lr.py +1 -1
  118. shaped/autogen/models/lr1.py +1 -1
  119. shaped/autogen/models/lr2.py +1 -1
  120. shaped/autogen/models/max_depth.py +1 -1
  121. shaped/autogen/models/max_leaves.py +1 -1
  122. shaped/autogen/models/max_seq_length.py +1 -1
  123. shaped/autogen/models/max_seq_length1.py +1 -1
  124. shaped/autogen/models/max_seq_length2.py +1 -1
  125. shaped/autogen/models/mode.py +1 -1
  126. shaped/autogen/models/mode1.py +20 -18
  127. shaped/autogen/models/mode2.py +32 -18
  128. shaped/autogen/models/models_inner.py +308 -0
  129. shaped/autogen/models/mongo_db_table_config.py +1 -1
  130. shaped/autogen/models/mssql_table_config.py +1 -1
  131. shaped/autogen/models/my_sql_table_config.py +1 -1
  132. shaped/autogen/models/n_epochs.py +1 -1
  133. shaped/autogen/models/n_epochs1.py +1 -1
  134. shaped/autogen/models/n_epochs2.py +1 -1
  135. shaped/autogen/models/n_estimators.py +1 -1
  136. shaped/autogen/models/n_heads.py +1 -1
  137. shaped/autogen/models/n_layers.py +1 -1
  138. shaped/autogen/models/neg_per_positive.py +1 -1
  139. shaped/autogen/models/negative_samples_count.py +1 -1
  140. shaped/autogen/models/ngram_tokenizer.py +1 -1
  141. shaped/autogen/models/no_op_config.py +1 -1
  142. shaped/autogen/models/num_blocks.py +1 -1
  143. shaped/autogen/models/num_heads.py +1 -1
  144. shaped/autogen/models/num_leaves.py +1 -1
  145. shaped/autogen/models/objective.py +1 -1
  146. shaped/autogen/models/objective1.py +1 -1
  147. shaped/autogen/models/online_store_config.py +1 -1
  148. shaped/autogen/models/pagination_config.py +1 -1
  149. shaped/autogen/models/parameter_definition.py +1 -1
  150. shaped/autogen/models/parameters_value.py +1 -1
  151. shaped/autogen/models/passthrough_score.py +1 -1
  152. shaped/autogen/models/personal_filter.py +1 -1
  153. shaped/autogen/models/pipeline_stage_explanation.py +4 -4
  154. shaped/autogen/models/policy.py +1 -1
  155. shaped/autogen/models/pool_fn.py +39 -21
  156. shaped/autogen/models/pooling_function.py +1 -1
  157. shaped/autogen/models/postgres_table_config.py +1 -1
  158. shaped/autogen/models/posthog_table_config.py +1 -1
  159. shaped/autogen/models/prebuilt_filter_step.py +1 -1
  160. shaped/autogen/models/precomputed_item_embedding.py +1 -1
  161. shaped/autogen/models/precomputed_user_embedding.py +1 -1
  162. shaped/autogen/models/query.py +15 -15
  163. shaped/autogen/models/query1.py +15 -15
  164. shaped/autogen/models/query_any_of.py +58 -26
  165. shaped/autogen/models/query_config.py +140 -0
  166. shaped/autogen/models/query_definition.py +1 -1
  167. shaped/autogen/models/query_encoder.py +1 -1
  168. shaped/autogen/models/query_explanation.py +7 -3
  169. shaped/autogen/models/query_request.py +1 -1
  170. shaped/autogen/models/query_result.py +1 -1
  171. shaped/autogen/models/query_table_config.py +1 -1
  172. shaped/autogen/models/rank_item_attribute_values_query_config.py +1 -1
  173. shaped/autogen/models/rank_query_config.py +7 -7
  174. shaped/autogen/models/rank_query_config_filter_inner.py +1 -1
  175. shaped/autogen/models/rank_query_config_reorder_inner.py +62 -25
  176. shaped/autogen/models/rank_query_config_retrieve_inner.py +100 -31
  177. shaped/autogen/models/recreate_rollout.py +1 -1
  178. shaped/autogen/models/redshift_table_config.py +1 -1
  179. shaped/autogen/models/reference_table_config.py +1 -1
  180. shaped/autogen/models/regularization.py +1 -1
  181. shaped/autogen/models/reorder_inner.py +149 -0
  182. shaped/autogen/models/reorder_step_explanation.py +207 -0
  183. shaped/autogen/models/request.py +1 -1
  184. shaped/autogen/models/request1.py +1 -1
  185. shaped/autogen/models/requests_per_second_scaling_policy.py +1 -1
  186. shaped/autogen/models/resource_config.py +100 -0
  187. shaped/autogen/models/response_get_view_details_views_view_name_get.py +1 -1
  188. shaped/autogen/models/result.py +1 -14
  189. shaped/autogen/models/result_embeddings_value.py +1 -1
  190. shaped/autogen/models/retrieval_scores_value.py +127 -0
  191. shaped/autogen/models/retrieve_inner.py +196 -0
  192. shaped/autogen/models/retrieve_step_explanation.py +172 -0
  193. shaped/autogen/models/retriever.py +1 -1
  194. shaped/autogen/models/retriever1.py +1 -1
  195. shaped/autogen/models/rollout_config.py +1 -1
  196. shaped/autogen/models/rudderstack_table_config.py +1 -1
  197. shaped/autogen/models/sampling_strategy.py +1 -1
  198. shaped/autogen/models/saved_query_info_response.py +18 -4
  199. shaped/autogen/models/saved_query_list_response.py +1 -1
  200. shaped/autogen/models/saved_query_request.py +1 -1
  201. shaped/autogen/models/schema_config.py +1 -1
  202. shaped/autogen/models/score.py +1 -1
  203. shaped/autogen/models/score_ensemble.py +1 -14
  204. shaped/autogen/models/score_ensemble_policy_config.py +49 -25
  205. shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +456 -123
  206. shaped/autogen/models/score_step_explanation.py +224 -0
  207. shaped/autogen/models/search_config.py +1 -1
  208. shaped/autogen/models/segment_table_config.py +1 -1
  209. shaped/autogen/models/sequence_length.py +1 -1
  210. shaped/autogen/models/server_config.py +14 -1
  211. shaped/autogen/models/setup_engine_response.py +1 -1
  212. shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +9 -3
  213. shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +9 -3
  214. shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +10 -4
  215. shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +46 -27
  216. shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +6 -4
  217. shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +9 -3
  218. shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +1 -1
  219. shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +77 -34
  220. shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +9 -3
  221. shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +1 -1
  222. shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +52 -28
  223. shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +21 -17
  224. shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +36 -23
  225. shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +1 -1
  226. shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +9 -3
  227. shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +1 -1
  228. shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +9 -3
  229. shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +53 -31
  230. shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +10 -4
  231. shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +12 -6
  232. shaped/autogen/models/shopify_table_config.py +1 -1
  233. shaped/autogen/models/similarity_retrieve_step.py +6 -4
  234. shaped/autogen/models/snowflake_table_config.py +1 -1
  235. shaped/autogen/models/sql_transform_type.py +1 -1
  236. shaped/autogen/models/sql_view_config.py +1 -1
  237. shaped/autogen/models/stemmer_tokenizer.py +1 -1
  238. shaped/autogen/models/step_explanation.py +1 -1
  239. shaped/autogen/models/steps_inner.py +179 -0
  240. shaped/autogen/models/strategy.py +1 -1
  241. shaped/autogen/models/table.py +1 -1
  242. shaped/autogen/models/table_deployment_type.py +1 -1
  243. shaped/autogen/models/table_insert_arguments.py +3 -3
  244. shaped/autogen/models/table_insert_response.py +1 -1
  245. shaped/autogen/models/text_encoding.py +29 -17
  246. shaped/autogen/models/text_search_retrieve_step.py +1 -1
  247. shaped/autogen/models/time_frequency.py +1 -1
  248. shaped/autogen/models/time_window.py +1 -1
  249. shaped/autogen/models/time_window_in_days.py +29 -17
  250. shaped/autogen/models/tokenizer.py +1 -1
  251. shaped/autogen/models/trained_model_encoder.py +1 -1
  252. shaped/autogen/models/training_compute_config.py +4 -4
  253. shaped/autogen/models/training_config.py +4 -4
  254. shaped/autogen/models/training_config_models_inner.py +325 -93
  255. shaped/autogen/models/training_strategy.py +1 -1
  256. shaped/autogen/models/transform_status.py +41 -0
  257. shaped/autogen/models/trending_mode.py +4 -4
  258. shaped/autogen/models/truncate_filter_step.py +1 -1
  259. shaped/autogen/models/tunable_bool.py +1 -1
  260. shaped/autogen/models/tunable_float.py +1 -1
  261. shaped/autogen/models/tunable_int.py +1 -1
  262. shaped/autogen/models/tunable_int_categorical.py +1 -1
  263. shaped/autogen/models/tunable_string.py +1 -1
  264. shaped/autogen/models/tuning_config.py +1 -1
  265. shaped/autogen/models/type.py +36 -20
  266. shaped/autogen/models/update_table_response.py +1 -1
  267. shaped/autogen/models/update_view_response.py +1 -1
  268. shaped/autogen/models/user_attribute_pooling_encoder.py +1 -1
  269. shaped/autogen/models/user_inner.py +134 -0
  270. shaped/autogen/models/val_split.py +1 -1
  271. shaped/autogen/models/validation_error.py +4 -4
  272. shaped/autogen/models/validation_error_loc_inner.py +28 -16
  273. shaped/autogen/models/value_type.py +1 -1
  274. shaped/autogen/models/vector_search_mode.py +6 -4
  275. shaped/autogen/models/view.py +4 -4
  276. shaped/autogen/models/view_details_ai.py +6 -6
  277. shaped/autogen/models/view_details_ai_schema_value.py +1 -1
  278. shaped/autogen/models/view_details_sql.py +6 -6
  279. shaped/autogen/models/view_status.py +8 -8
  280. shaped/autogen/models/weight_decay.py +1 -1
  281. shaped/autogen/models/whitespace_tokenizer.py +1 -1
  282. shaped/autogen/models/window_size.py +1 -1
  283. shaped/autogen/rest.py +9 -9
  284. shaped/cli/shaped_cli.py +152 -29
  285. shaped/client.py +50 -43
  286. shaped/config_builders.py +110 -100
  287. shaped/query_builder.py +56 -49
  288. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/METADATA +2 -2
  289. shaped-2.0.4.dist-info/RECORD +296 -0
  290. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/WHEEL +1 -1
  291. shaped-2.0.2.dist-info/RECORD +0 -278
  292. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/entry_points.txt +0 -0
  293. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/top_level.txt +0 -0
  294. {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/zip-safe +0 -0
@@ -5,7 +5,7 @@
5
5
 
6
6
  Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -44,7 +44,6 @@ class QueryApi:
44
44
  @validate_call
45
45
  def execute_ad_hoc_query_query_post(
46
46
  self,
47
- engine_name: StrictStr,
48
47
  query_request: QueryRequest,
49
48
  _request_timeout: Union[
50
49
  None,
@@ -63,8 +62,6 @@ class QueryApi:
63
62
 
64
63
  Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
65
64
 
66
- :param engine_name: (required)
67
- :type engine_name: str
68
65
  :param query_request: (required)
69
66
  :type query_request: QueryRequest
70
67
  :param _request_timeout: timeout setting for this request. If one
@@ -90,7 +87,6 @@ class QueryApi:
90
87
  """ # noqa: E501
91
88
 
92
89
  _param = self._execute_ad_hoc_query_query_post_serialize(
93
- engine_name=engine_name,
94
90
  query_request=query_request,
95
91
  _request_auth=_request_auth,
96
92
  _content_type=_content_type,
@@ -116,7 +112,6 @@ class QueryApi:
116
112
  @validate_call
117
113
  def execute_ad_hoc_query_query_post_with_http_info(
118
114
  self,
119
- engine_name: StrictStr,
120
115
  query_request: QueryRequest,
121
116
  _request_timeout: Union[
122
117
  None,
@@ -135,8 +130,6 @@ class QueryApi:
135
130
 
136
131
  Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
137
132
 
138
- :param engine_name: (required)
139
- :type engine_name: str
140
133
  :param query_request: (required)
141
134
  :type query_request: QueryRequest
142
135
  :param _request_timeout: timeout setting for this request. If one
@@ -162,7 +155,6 @@ class QueryApi:
162
155
  """ # noqa: E501
163
156
 
164
157
  _param = self._execute_ad_hoc_query_query_post_serialize(
165
- engine_name=engine_name,
166
158
  query_request=query_request,
167
159
  _request_auth=_request_auth,
168
160
  _content_type=_content_type,
@@ -188,7 +180,6 @@ class QueryApi:
188
180
  @validate_call
189
181
  def execute_ad_hoc_query_query_post_without_preload_content(
190
182
  self,
191
- engine_name: StrictStr,
192
183
  query_request: QueryRequest,
193
184
  _request_timeout: Union[
194
185
  None,
@@ -207,8 +198,6 @@ class QueryApi:
207
198
 
208
199
  Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
209
200
 
210
- :param engine_name: (required)
211
- :type engine_name: str
212
201
  :param query_request: (required)
213
202
  :type query_request: QueryRequest
214
203
  :param _request_timeout: timeout setting for this request. If one
@@ -234,7 +223,6 @@ class QueryApi:
234
223
  """ # noqa: E501
235
224
 
236
225
  _param = self._execute_ad_hoc_query_query_post_serialize(
237
- engine_name=engine_name,
238
226
  query_request=query_request,
239
227
  _request_auth=_request_auth,
240
228
  _content_type=_content_type,
@@ -255,7 +243,6 @@ class QueryApi:
255
243
 
256
244
  def _execute_ad_hoc_query_query_post_serialize(
257
245
  self,
258
- engine_name,
259
246
  query_request,
260
247
  _request_auth,
261
248
  _content_type,
@@ -278,8 +265,6 @@ class QueryApi:
278
265
  _body_params: Optional[bytes] = None
279
266
 
280
267
  # process the path parameters
281
- if engine_name is not None:
282
- _path_params['engine_name'] = engine_name
283
268
  # process the query parameters
284
269
  # process the header parameters
285
270
  # process the form parameters
@@ -316,7 +301,7 @@ class QueryApi:
316
301
 
317
302
  return self.api_client.param_serialize(
318
303
  method='POST',
319
- resource_path='/engines/{engine_name}/query',
304
+ resource_path='/query',
320
305
  path_params=_path_params,
321
306
  query_params=_query_params,
322
307
  header_params=_header_params,
@@ -335,7 +320,6 @@ class QueryApi:
335
320
  @validate_call
336
321
  def execute_saved_query_queries_query_name_post(
337
322
  self,
338
- engine_name: StrictStr,
339
323
  query_name: StrictStr,
340
324
  saved_query_request: SavedQueryRequest,
341
325
  _request_timeout: Union[
@@ -355,8 +339,6 @@ class QueryApi:
355
339
 
356
340
  Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
357
341
 
358
- :param engine_name: (required)
359
- :type engine_name: str
360
342
  :param query_name: (required)
361
343
  :type query_name: str
362
344
  :param saved_query_request: (required)
@@ -384,7 +366,6 @@ class QueryApi:
384
366
  """ # noqa: E501
385
367
 
386
368
  _param = self._execute_saved_query_queries_query_name_post_serialize(
387
- engine_name=engine_name,
388
369
  query_name=query_name,
389
370
  saved_query_request=saved_query_request,
390
371
  _request_auth=_request_auth,
@@ -411,7 +392,6 @@ class QueryApi:
411
392
  @validate_call
412
393
  def execute_saved_query_queries_query_name_post_with_http_info(
413
394
  self,
414
- engine_name: StrictStr,
415
395
  query_name: StrictStr,
416
396
  saved_query_request: SavedQueryRequest,
417
397
  _request_timeout: Union[
@@ -431,8 +411,6 @@ class QueryApi:
431
411
 
432
412
  Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
433
413
 
434
- :param engine_name: (required)
435
- :type engine_name: str
436
414
  :param query_name: (required)
437
415
  :type query_name: str
438
416
  :param saved_query_request: (required)
@@ -460,7 +438,6 @@ class QueryApi:
460
438
  """ # noqa: E501
461
439
 
462
440
  _param = self._execute_saved_query_queries_query_name_post_serialize(
463
- engine_name=engine_name,
464
441
  query_name=query_name,
465
442
  saved_query_request=saved_query_request,
466
443
  _request_auth=_request_auth,
@@ -487,7 +464,6 @@ class QueryApi:
487
464
  @validate_call
488
465
  def execute_saved_query_queries_query_name_post_without_preload_content(
489
466
  self,
490
- engine_name: StrictStr,
491
467
  query_name: StrictStr,
492
468
  saved_query_request: SavedQueryRequest,
493
469
  _request_timeout: Union[
@@ -507,8 +483,6 @@ class QueryApi:
507
483
 
508
484
  Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
509
485
 
510
- :param engine_name: (required)
511
- :type engine_name: str
512
486
  :param query_name: (required)
513
487
  :type query_name: str
514
488
  :param saved_query_request: (required)
@@ -536,7 +510,6 @@ class QueryApi:
536
510
  """ # noqa: E501
537
511
 
538
512
  _param = self._execute_saved_query_queries_query_name_post_serialize(
539
- engine_name=engine_name,
540
513
  query_name=query_name,
541
514
  saved_query_request=saved_query_request,
542
515
  _request_auth=_request_auth,
@@ -558,7 +531,6 @@ class QueryApi:
558
531
 
559
532
  def _execute_saved_query_queries_query_name_post_serialize(
560
533
  self,
561
- engine_name,
562
534
  query_name,
563
535
  saved_query_request,
564
536
  _request_auth,
@@ -582,8 +554,6 @@ class QueryApi:
582
554
  _body_params: Optional[bytes] = None
583
555
 
584
556
  # process the path parameters
585
- if engine_name is not None:
586
- _path_params['engine_name'] = engine_name
587
557
  if query_name is not None:
588
558
  _path_params['query_name'] = query_name
589
559
  # process the query parameters
@@ -622,7 +592,7 @@ class QueryApi:
622
592
 
623
593
  return self.api_client.param_serialize(
624
594
  method='POST',
625
- resource_path='/engines/{engine_name}/queries/{query_name}',
595
+ resource_path='/queries/{query_name}',
626
596
  path_params=_path_params,
627
597
  query_params=_query_params,
628
598
  header_params=_header_params,
@@ -641,7 +611,6 @@ class QueryApi:
641
611
  @validate_call
642
612
  def get_saved_query_info_queries_query_name_get(
643
613
  self,
644
- engine_name: StrictStr,
645
614
  query_name: StrictStr,
646
615
  _request_timeout: Union[
647
616
  None,
@@ -660,8 +629,6 @@ class QueryApi:
660
629
 
661
630
  Get information about a specific saved query.
662
631
 
663
- :param engine_name: (required)
664
- :type engine_name: str
665
632
  :param query_name: (required)
666
633
  :type query_name: str
667
634
  :param _request_timeout: timeout setting for this request. If one
@@ -687,7 +654,6 @@ class QueryApi:
687
654
  """ # noqa: E501
688
655
 
689
656
  _param = self._get_saved_query_info_queries_query_name_get_serialize(
690
- engine_name=engine_name,
691
657
  query_name=query_name,
692
658
  _request_auth=_request_auth,
693
659
  _content_type=_content_type,
@@ -713,7 +679,6 @@ class QueryApi:
713
679
  @validate_call
714
680
  def get_saved_query_info_queries_query_name_get_with_http_info(
715
681
  self,
716
- engine_name: StrictStr,
717
682
  query_name: StrictStr,
718
683
  _request_timeout: Union[
719
684
  None,
@@ -732,8 +697,6 @@ class QueryApi:
732
697
 
733
698
  Get information about a specific saved query.
734
699
 
735
- :param engine_name: (required)
736
- :type engine_name: str
737
700
  :param query_name: (required)
738
701
  :type query_name: str
739
702
  :param _request_timeout: timeout setting for this request. If one
@@ -759,7 +722,6 @@ class QueryApi:
759
722
  """ # noqa: E501
760
723
 
761
724
  _param = self._get_saved_query_info_queries_query_name_get_serialize(
762
- engine_name=engine_name,
763
725
  query_name=query_name,
764
726
  _request_auth=_request_auth,
765
727
  _content_type=_content_type,
@@ -785,7 +747,6 @@ class QueryApi:
785
747
  @validate_call
786
748
  def get_saved_query_info_queries_query_name_get_without_preload_content(
787
749
  self,
788
- engine_name: StrictStr,
789
750
  query_name: StrictStr,
790
751
  _request_timeout: Union[
791
752
  None,
@@ -804,8 +765,6 @@ class QueryApi:
804
765
 
805
766
  Get information about a specific saved query.
806
767
 
807
- :param engine_name: (required)
808
- :type engine_name: str
809
768
  :param query_name: (required)
810
769
  :type query_name: str
811
770
  :param _request_timeout: timeout setting for this request. If one
@@ -831,7 +790,6 @@ class QueryApi:
831
790
  """ # noqa: E501
832
791
 
833
792
  _param = self._get_saved_query_info_queries_query_name_get_serialize(
834
- engine_name=engine_name,
835
793
  query_name=query_name,
836
794
  _request_auth=_request_auth,
837
795
  _content_type=_content_type,
@@ -852,7 +810,6 @@ class QueryApi:
852
810
 
853
811
  def _get_saved_query_info_queries_query_name_get_serialize(
854
812
  self,
855
- engine_name,
856
813
  query_name,
857
814
  _request_auth,
858
815
  _content_type,
@@ -875,8 +832,6 @@ class QueryApi:
875
832
  _body_params: Optional[bytes] = None
876
833
 
877
834
  # process the path parameters
878
- if engine_name is not None:
879
- _path_params['engine_name'] = engine_name
880
835
  if query_name is not None:
881
836
  _path_params['query_name'] = query_name
882
837
  # process the query parameters
@@ -900,7 +855,7 @@ class QueryApi:
900
855
 
901
856
  return self.api_client.param_serialize(
902
857
  method='GET',
903
- resource_path='/engines/{engine_name}/queries/{query_name}',
858
+ resource_path='/queries/{query_name}',
904
859
  path_params=_path_params,
905
860
  query_params=_query_params,
906
861
  header_params=_header_params,
@@ -919,7 +874,6 @@ class QueryApi:
919
874
  @validate_call
920
875
  def list_saved_queries_queries_get(
921
876
  self,
922
- engine_name: StrictStr,
923
877
  _request_timeout: Union[
924
878
  None,
925
879
  Annotated[StrictFloat, Field(gt=0)],
@@ -935,10 +889,8 @@ class QueryApi:
935
889
  ) -> SavedQueryListResponse:
936
890
  """List Saved Queries
937
891
 
938
- List all available saved queries for an engine.
892
+ List all available saved queries.
939
893
 
940
- :param engine_name: (required)
941
- :type engine_name: str
942
894
  :param _request_timeout: timeout setting for this request. If one
943
895
  number provided, it will be total request
944
896
  timeout. It can also be a pair (tuple) of
@@ -962,7 +914,6 @@ class QueryApi:
962
914
  """ # noqa: E501
963
915
 
964
916
  _param = self._list_saved_queries_queries_get_serialize(
965
- engine_name=engine_name,
966
917
  _request_auth=_request_auth,
967
918
  _content_type=_content_type,
968
919
  _headers=_headers,
@@ -986,7 +937,6 @@ class QueryApi:
986
937
  @validate_call
987
938
  def list_saved_queries_queries_get_with_http_info(
988
939
  self,
989
- engine_name: StrictStr,
990
940
  _request_timeout: Union[
991
941
  None,
992
942
  Annotated[StrictFloat, Field(gt=0)],
@@ -1002,10 +952,8 @@ class QueryApi:
1002
952
  ) -> ApiResponse[SavedQueryListResponse]:
1003
953
  """List Saved Queries
1004
954
 
1005
- List all available saved queries for an engine.
955
+ List all available saved queries.
1006
956
 
1007
- :param engine_name: (required)
1008
- :type engine_name: str
1009
957
  :param _request_timeout: timeout setting for this request. If one
1010
958
  number provided, it will be total request
1011
959
  timeout. It can also be a pair (tuple) of
@@ -1029,7 +977,6 @@ class QueryApi:
1029
977
  """ # noqa: E501
1030
978
 
1031
979
  _param = self._list_saved_queries_queries_get_serialize(
1032
- engine_name=engine_name,
1033
980
  _request_auth=_request_auth,
1034
981
  _content_type=_content_type,
1035
982
  _headers=_headers,
@@ -1053,7 +1000,6 @@ class QueryApi:
1053
1000
  @validate_call
1054
1001
  def list_saved_queries_queries_get_without_preload_content(
1055
1002
  self,
1056
- engine_name: StrictStr,
1057
1003
  _request_timeout: Union[
1058
1004
  None,
1059
1005
  Annotated[StrictFloat, Field(gt=0)],
@@ -1069,10 +1015,8 @@ class QueryApi:
1069
1015
  ) -> RESTResponseType:
1070
1016
  """List Saved Queries
1071
1017
 
1072
- List all available saved queries for an engine.
1018
+ List all available saved queries.
1073
1019
 
1074
- :param engine_name: (required)
1075
- :type engine_name: str
1076
1020
  :param _request_timeout: timeout setting for this request. If one
1077
1021
  number provided, it will be total request
1078
1022
  timeout. It can also be a pair (tuple) of
@@ -1096,7 +1040,6 @@ class QueryApi:
1096
1040
  """ # noqa: E501
1097
1041
 
1098
1042
  _param = self._list_saved_queries_queries_get_serialize(
1099
- engine_name=engine_name,
1100
1043
  _request_auth=_request_auth,
1101
1044
  _content_type=_content_type,
1102
1045
  _headers=_headers,
@@ -1115,7 +1058,6 @@ class QueryApi:
1115
1058
 
1116
1059
  def _list_saved_queries_queries_get_serialize(
1117
1060
  self,
1118
- engine_name,
1119
1061
  _request_auth,
1120
1062
  _content_type,
1121
1063
  _headers,
@@ -1137,8 +1079,6 @@ class QueryApi:
1137
1079
  _body_params: Optional[bytes] = None
1138
1080
 
1139
1081
  # process the path parameters
1140
- if engine_name is not None:
1141
- _path_params['engine_name'] = engine_name
1142
1082
  # process the query parameters
1143
1083
  # process the header parameters
1144
1084
  # process the form parameters
@@ -1160,7 +1100,7 @@ class QueryApi:
1160
1100
 
1161
1101
  return self.api_client.param_serialize(
1162
1102
  method='GET',
1163
- resource_path='/engines/{engine_name}/queries',
1103
+ resource_path='/queries',
1164
1104
  path_params=_path_params,
1165
1105
  query_params=_query_params,
1166
1106
  header_params=_header_params,
@@ -5,7 +5,7 @@
5
5
 
6
6
  Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
6
  Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -5,7 +5,7 @@
5
5
 
6
6
  Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -312,7 +312,7 @@ class ApiClient:
312
312
  return_data = self.__deserialize_file(response_data)
313
313
  elif response_type is not None:
314
314
  match = None
315
- content_type = response_data.getheader('content-type')
315
+ content_type = response_data.headers.get('content-type')
316
316
  if content_type is not None:
317
317
  match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
318
318
  encoding = match.group(1) if match else "utf-8"
@@ -329,7 +329,7 @@ class ApiClient:
329
329
  return ApiResponse(
330
330
  status_code = response_data.status,
331
331
  data = return_data,
332
- headers = response_data.getheaders(),
332
+ headers = response_data.headers,
333
333
  raw_data = response_data.data
334
334
  )
335
335
 
@@ -701,7 +701,7 @@ class ApiClient:
701
701
  os.close(fd)
702
702
  os.remove(path)
703
703
 
704
- content_disposition = response.getheader("Content-Disposition")
704
+ content_disposition = response.headers.get("Content-Disposition")
705
705
  if content_disposition:
706
706
  m = re.search(
707
707
  r'filename=[\'"]?([^\'"\s]+)[\'"]?',
@@ -5,7 +5,7 @@
5
5
 
6
6
  Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -163,7 +163,7 @@ class Configuration:
163
163
  :param ca_cert_data: verify the peer using concatenated CA certificate data
164
164
  in PEM (str) or DER (bytes) format.
165
165
  :param cert_file: the path to a client certificate file, for mTLS.
166
- :param key_file: the path to a client key file, for mTLS.
166
+ :param key_file: the path to a client key file, for mTLS.
167
167
 
168
168
  """
169
169
 
@@ -484,6 +484,7 @@ class Configuration:
484
484
  password = ""
485
485
  if self.password is not None:
486
486
  password = self.password
487
+
487
488
  return urllib3.util.make_headers(
488
489
  basic_auth=username + ':' + password
489
490
  ).get('authorization')
@@ -504,7 +505,7 @@ class Configuration:
504
505
  return "Python SDK Debug Report:\n"\
505
506
  "OS: {env}\n"\
506
507
  "Python Version: {pyversion}\n"\
507
- "Version of the API: 2.0.0\n"\
508
+ "Version of the API: 2.0.4\n"\
508
509
  "SDK Package Version: 1.0.0".\
509
510
  format(env=sys.platform, pyversion=sys.version)
510
511
 
@@ -553,6 +554,7 @@ class Configuration:
553
554
  variable_name, variable['default_value'])
554
555
 
555
556
  if 'enum_values' in variable \
557
+ and variable['enum_values'] \
556
558
  and used_value not in variable['enum_values']:
557
559
  raise ValueError(
558
560
  "The variable `{0}` in the host URL has invalid value "
@@ -5,7 +5,7 @@
5
5
 
6
6
  Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
7
7
 
8
- The version of the OpenAPI document: 2.0.0
8
+ The version of the OpenAPI document: 2.0.4
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -128,7 +128,7 @@ class ApiException(OpenApiException):
128
128
  self.body = http_resp.data.decode('utf-8')
129
129
  except Exception:
130
130
  pass
131
- self.headers = http_resp.getheaders()
131
+ self.headers = http_resp.headers
132
132
 
133
133
  @classmethod
134
134
  def from_response(
@@ -169,8 +169,11 @@ class ApiException(OpenApiException):
169
169
  error_message += "HTTP response headers: {0}\n".format(
170
170
  self.headers)
171
171
 
172
- if self.data or self.body:
173
- error_message += "HTTP response body: {0}\n".format(self.data or self.body)
172
+ if self.body:
173
+ error_message += "HTTP response body: {0}\n".format(self.body)
174
+
175
+ if self.data:
176
+ error_message += "HTTP response data: {0}\n".format(self.data)
174
177
 
175
178
  return error_message
176
179