shaped 2.0.2__py3-none-any.whl → 2.0.5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- shaped/__init__.py +47 -42
- shaped/autogen/__init__.py +41 -56
- shaped/autogen/api/engine_api.py +5 -6
- shaped/autogen/api/query_api.py +12 -73
- shaped/autogen/api/table_api.py +5 -6
- shaped/autogen/api/view_api.py +5 -6
- shaped/autogen/api_client.py +8 -9
- shaped/autogen/configuration.py +9 -8
- shaped/autogen/exceptions.py +11 -9
- shaped/autogen/models/__init__.py +23 -31
- shaped/autogen/models/ai_enrichment_view_config.py +5 -6
- shaped/autogen/models/algorithm.py +5 -6
- shaped/autogen/models/amplitude_table_config.py +5 -6
- shaped/autogen/models/attn_dropout_prob.py +5 -6
- shaped/autogen/models/attribute_journey.py +5 -6
- shaped/autogen/models/attribute_value.py +5 -6
- shaped/autogen/models/autoscaling_config.py +5 -6
- shaped/autogen/models/aws_pinpoint_table_config.py +5 -6
- shaped/autogen/models/batch_size.py +5 -6
- shaped/autogen/models/batch_size1.py +5 -6
- shaped/autogen/models/batch_size2.py +5 -6
- shaped/autogen/models/big_query_table_config.py +5 -6
- shaped/autogen/models/bm25.py +5 -6
- shaped/autogen/models/boosted_reorder_step.py +5 -6
- shaped/autogen/models/canary_rollout.py +5 -6
- shaped/autogen/models/candidate_attributes_retrieve_step.py +5 -19
- shaped/autogen/models/candidate_ids_retrieve_step.py +5 -6
- shaped/autogen/models/candidate_retrieval_strategy.py +5 -6
- shaped/autogen/models/clickhouse_table_config.py +5 -6
- shaped/autogen/models/column_order_retrieve_step.py +5 -6
- shaped/autogen/models/column_ordering.py +5 -6
- shaped/autogen/models/create_table_response.py +5 -6
- shaped/autogen/models/create_view_response.py +5 -6
- shaped/autogen/models/custom_table_config.py +5 -6
- shaped/autogen/models/data_compute_config.py +5 -6
- shaped/autogen/models/data_config.py +5 -6
- shaped/autogen/models/data_config_interaction_table.py +5 -6
- shaped/autogen/models/data_split_config.py +5 -6
- shaped/autogen/models/data_split_strategy.py +5 -6
- shaped/autogen/models/data_tier.py +5 -6
- shaped/autogen/models/default.py +5 -6
- shaped/autogen/models/delete_engine_response.py +5 -6
- shaped/autogen/models/delete_table_response.py +5 -6
- shaped/autogen/models/delete_view_response.py +5 -6
- shaped/autogen/models/deployment_config.py +6 -13
- shaped/autogen/models/diversity_reorder_step.py +5 -6
- shaped/autogen/models/dropout_rate.py +5 -6
- shaped/autogen/models/dynamo_db_table_config.py +5 -6
- shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +5 -6
- shaped/autogen/models/embedder_batch_size.py +5 -6
- shaped/autogen/models/embedding_config.py +5 -6
- shaped/autogen/models/embedding_dim.py +5 -6
- shaped/autogen/models/embedding_dims.py +5 -6
- shaped/autogen/models/embedding_size.py +5 -6
- shaped/autogen/models/encoder.py +5 -6
- shaped/autogen/models/engine.py +5 -6
- shaped/autogen/models/engine_config_v2.py +5 -6
- shaped/autogen/models/engine_details_response.py +5 -6
- shaped/autogen/models/engine_schema.py +12 -13
- shaped/autogen/models/entity_config.py +5 -6
- shaped/autogen/models/entity_journey.py +32 -24
- shaped/autogen/models/entity_type.py +5 -6
- shaped/autogen/models/evaluation_config.py +5 -6
- shaped/autogen/models/exploration_reorder_step.py +5 -6
- shaped/autogen/models/expression_filter_step.py +5 -6
- shaped/autogen/models/factors.py +5 -6
- shaped/autogen/models/factors1.py +5 -6
- shaped/autogen/models/feature.py +5 -6
- shaped/autogen/models/feature_type.py +5 -6
- shaped/autogen/models/file_table_config.py +5 -6
- shaped/autogen/models/filter_config.py +18 -19
- shaped/autogen/models/filter_index_type.py +5 -6
- shaped/autogen/models/filter_retrieve_step.py +5 -6
- shaped/autogen/models/filter_step_explanation.py +164 -0
- shaped/autogen/models/{filter_dataset.py → filter_table.py} +12 -13
- shaped/autogen/models/{type.py → filter_type.py} +10 -11
- shaped/autogen/models/global_filter.py +5 -6
- shaped/autogen/models/hidden_dropout_prob.py +5 -6
- shaped/autogen/models/hidden_size.py +5 -6
- shaped/autogen/models/hidden_size1.py +5 -6
- shaped/autogen/models/http_problem_response.py +5 -6
- shaped/autogen/models/http_validation_error.py +5 -6
- shaped/autogen/models/hugging_face_encoder.py +10 -9
- shaped/autogen/models/iceberg_table_config.py +5 -6
- shaped/autogen/models/index_config.py +5 -6
- shaped/autogen/models/{time_window_in_days.py → inner_entity_id.py} +27 -26
- shaped/autogen/models/inner_size.py +5 -6
- shaped/autogen/models/inner_size1.py +5 -6
- shaped/autogen/models/{mode2.py → inner_uid.py} +37 -30
- shaped/autogen/models/interaction_config.py +5 -6
- shaped/autogen/models/interaction_pooling_encoder.py +5 -6
- shaped/autogen/models/interaction_round_robin_encoder.py +5 -6
- shaped/autogen/models/item_attribute_pooling_encoder.py +5 -19
- shaped/autogen/models/journey.py +5 -6
- shaped/autogen/models/kafka_table_config.py +5 -6
- shaped/autogen/models/kinesis_table_config.py +5 -6
- shaped/autogen/models/kinesis_table_config_column_schema_value.py +5 -6
- shaped/autogen/models/label.py +5 -6
- shaped/autogen/models/label_type.py +5 -7
- shaped/autogen/models/laplace_smoothing.py +5 -6
- shaped/autogen/models/latency_scaling_policy.py +5 -6
- shaped/autogen/models/learning_rate.py +5 -6
- shaped/autogen/models/learning_rate1.py +5 -6
- shaped/autogen/models/learning_rate2.py +5 -6
- shaped/autogen/models/learning_rate3.py +5 -6
- shaped/autogen/models/lexical_search_mode.py +7 -8
- shaped/autogen/models/list_engines_response.py +5 -6
- shaped/autogen/models/list_tables_response.py +5 -6
- shaped/autogen/models/list_views_response.py +5 -6
- shaped/autogen/models/{validation_error_loc_inner.py → location_inner.py} +11 -12
- shaped/autogen/models/loss_types.py +5 -6
- shaped/autogen/models/lr.py +5 -6
- shaped/autogen/models/lr1.py +5 -6
- shaped/autogen/models/lr2.py +5 -6
- shaped/autogen/models/max_depth.py +5 -6
- shaped/autogen/models/max_leaves.py +5 -6
- shaped/autogen/models/max_seq_length.py +5 -6
- shaped/autogen/models/max_seq_length1.py +5 -6
- shaped/autogen/models/max_seq_length2.py +5 -6
- shaped/autogen/models/mode.py +5 -6
- shaped/autogen/models/mode1.py +24 -23
- shaped/autogen/models/{training_config_models_inner.py → models_inner.py} +13 -14
- shaped/autogen/models/mongo_db_table_config.py +5 -6
- shaped/autogen/models/mssql_table_config.py +5 -6
- shaped/autogen/models/my_sql_table_config.py +5 -6
- shaped/autogen/models/n_epochs.py +5 -6
- shaped/autogen/models/n_epochs1.py +5 -6
- shaped/autogen/models/n_epochs2.py +5 -6
- shaped/autogen/models/n_estimators.py +5 -6
- shaped/autogen/models/n_heads.py +5 -6
- shaped/autogen/models/n_layers.py +5 -6
- shaped/autogen/models/neg_per_positive.py +5 -6
- shaped/autogen/models/negative_samples_count.py +5 -6
- shaped/autogen/models/ngram_tokenizer.py +5 -6
- shaped/autogen/models/no_op_config.py +5 -6
- shaped/autogen/models/num_blocks.py +5 -6
- shaped/autogen/models/num_heads.py +5 -6
- shaped/autogen/models/num_leaves.py +5 -6
- shaped/autogen/models/objective.py +5 -6
- shaped/autogen/models/objective1.py +5 -6
- shaped/autogen/models/online_store_config.py +5 -6
- shaped/autogen/models/pagination_config.py +5 -6
- shaped/autogen/models/parameter_definition.py +5 -6
- shaped/autogen/models/parameters_value.py +5 -6
- shaped/autogen/models/passthrough_score.py +5 -6
- shaped/autogen/models/personal_filter.py +5 -6
- shaped/autogen/models/pipeline_stage_explanation.py +8 -9
- shaped/autogen/models/policy.py +5 -6
- shaped/autogen/models/pooling_function.py +5 -6
- shaped/autogen/models/postgres_table_config.py +5 -6
- shaped/autogen/models/posthog_table_config.py +5 -6
- shaped/autogen/models/prebuilt_filter_step.py +5 -6
- shaped/autogen/models/precomputed_item_embedding.py +5 -6
- shaped/autogen/models/precomputed_user_embedding.py +5 -6
- shaped/autogen/models/query.py +19 -20
- shaped/autogen/models/query1.py +19 -20
- shaped/autogen/models/{query_any_of.py → query_config.py} +13 -14
- shaped/autogen/models/query_definition.py +5 -6
- shaped/autogen/models/query_encoder.py +5 -6
- shaped/autogen/models/query_explanation.py +11 -8
- shaped/autogen/models/query_request.py +5 -6
- shaped/autogen/models/query_result.py +5 -6
- shaped/autogen/models/query_table_config.py +5 -6
- shaped/autogen/models/rank_item_attribute_values_query_config.py +5 -6
- shaped/autogen/models/rank_query_config.py +11 -12
- shaped/autogen/models/rank_query_config_filter_inner.py +5 -6
- shaped/autogen/models/recreate_rollout.py +5 -6
- shaped/autogen/models/redshift_table_config.py +5 -6
- shaped/autogen/models/reference_table_config.py +5 -6
- shaped/autogen/models/regularization.py +5 -6
- shaped/autogen/models/{rank_query_config_reorder_inner.py → reorder_inner.py} +11 -12
- shaped/autogen/models/reorder_step_explanation.py +206 -0
- shaped/autogen/models/request.py +5 -6
- shaped/autogen/models/request1.py +5 -6
- shaped/autogen/models/requests_per_second_scaling_policy.py +5 -6
- shaped/autogen/models/resource_config.py +99 -0
- shaped/autogen/models/response_get_view_details_views_view_name_get.py +5 -6
- shaped/autogen/models/result.py +5 -19
- shaped/autogen/models/result_embeddings_value.py +5 -6
- shaped/autogen/models/{ascending.py → retrieval_scores_value.py} +26 -36
- shaped/autogen/models/{rank_query_config_retrieve_inner.py → retrieve_inner.py} +13 -14
- shaped/autogen/models/retrieve_step_explanation.py +171 -0
- shaped/autogen/models/retriever.py +5 -6
- shaped/autogen/models/retriever1.py +5 -6
- shaped/autogen/models/rollout_config.py +5 -6
- shaped/autogen/models/rudderstack_table_config.py +5 -6
- shaped/autogen/models/sampling_strategy.py +5 -6
- shaped/autogen/models/saved_query_info_response.py +22 -9
- shaped/autogen/models/saved_query_list_response.py +5 -6
- shaped/autogen/models/saved_query_request.py +5 -6
- shaped/autogen/models/schema_config.py +5 -6
- shaped/autogen/models/score.py +5 -6
- shaped/autogen/models/score_ensemble.py +5 -19
- shaped/autogen/models/score_step_explanation.py +223 -0
- shaped/autogen/models/search_config.py +5 -6
- shaped/autogen/models/segment_table_config.py +5 -6
- shaped/autogen/models/sequence_length.py +5 -6
- shaped/autogen/models/server_config.py +18 -6
- shaped/autogen/models/setup_engine_response.py +5 -6
- shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +13 -8
- shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +13 -8
- shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +14 -9
- shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +10 -9
- shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +13 -8
- shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +5 -6
- shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +13 -8
- shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +5 -6
- shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +5 -6
- shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +13 -8
- shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +5 -6
- shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +13 -8
- shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +14 -9
- shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +16 -11
- shaped/autogen/models/shopify_table_config.py +5 -6
- shaped/autogen/models/similarity_retrieve_step.py +10 -9
- shaped/autogen/models/snowflake_table_config.py +5 -6
- shaped/autogen/models/sql_transform_type.py +5 -6
- shaped/autogen/models/sql_view_config.py +5 -6
- shaped/autogen/models/stemmer_tokenizer.py +5 -6
- shaped/autogen/models/step_explanation.py +5 -6
- shaped/autogen/models/steps_inner.py +178 -0
- shaped/autogen/models/strategy.py +5 -6
- shaped/autogen/models/table.py +5 -6
- shaped/autogen/models/table_deployment_type.py +5 -6
- shaped/autogen/models/table_insert_arguments.py +7 -8
- shaped/autogen/models/table_insert_response.py +5 -6
- shaped/autogen/models/text_search_retrieve_step.py +5 -6
- shaped/autogen/models/time_frequency.py +5 -6
- shaped/autogen/models/time_window.py +5 -6
- shaped/autogen/models/tokenizer.py +5 -6
- shaped/autogen/models/trained_model_encoder.py +5 -6
- shaped/autogen/models/training_compute_config.py +8 -9
- shaped/autogen/models/training_config.py +8 -9
- shaped/autogen/models/training_strategy.py +5 -6
- shaped/autogen/models/transform_status.py +40 -0
- shaped/autogen/models/truncate_filter_step.py +5 -6
- shaped/autogen/models/tunable_bool.py +5 -6
- shaped/autogen/models/tunable_float.py +5 -6
- shaped/autogen/models/tunable_int.py +5 -6
- shaped/autogen/models/tunable_int_categorical.py +5 -6
- shaped/autogen/models/tunable_string.py +5 -6
- shaped/autogen/models/tuning_config.py +5 -6
- shaped/autogen/models/update_table_response.py +5 -6
- shaped/autogen/models/update_view_response.py +5 -6
- shaped/autogen/models/user_attribute_pooling_encoder.py +5 -6
- shaped/autogen/models/{engine_schema_user_inner.py → user_inner.py} +11 -12
- shaped/autogen/models/val_split.py +5 -6
- shaped/autogen/models/validation_error.py +8 -9
- shaped/autogen/models/value_type.py +5 -6
- shaped/autogen/models/vector_search_mode.py +10 -9
- shaped/autogen/models/view.py +8 -9
- shaped/autogen/models/view_details_ai.py +10 -11
- shaped/autogen/models/view_details_ai_schema_value.py +5 -6
- shaped/autogen/models/view_details_sql.py +10 -11
- shaped/autogen/models/weight_decay.py +5 -6
- shaped/autogen/models/whitespace_tokenizer.py +5 -6
- shaped/autogen/models/window_size.py +5 -6
- shaped/autogen/rest.py +13 -14
- shaped/cli/shaped_cli.py +152 -29
- shaped/client.py +50 -43
- shaped/config_builders.py +110 -100
- shaped/query_builder.py +56 -49
- {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/METADATA +2 -2
- shaped-2.0.5.dist-info/RECORD +271 -0
- {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/WHEEL +1 -1
- shaped/autogen/models/distance_function.py +0 -38
- shaped/autogen/models/encoding_pooling_strategy.py +0 -38
- shaped/autogen/models/pool_fn.py +0 -134
- shaped/autogen/models/score_ensemble_policy_config.py +0 -141
- shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +0 -422
- shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +0 -137
- shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +0 -152
- shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +0 -137
- shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +0 -104
- shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +0 -130
- shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +0 -131
- shaped/autogen/models/text_encoding.py +0 -136
- shaped/autogen/models/trending_mode.py +0 -37
- shaped/autogen/models/view_status.py +0 -41
- shaped-2.0.2.dist-info/RECORD +0 -278
- {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/entry_points.txt +0 -0
- {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/top_level.txt +0 -0
- {shaped-2.0.2.dist-info → shaped-2.0.5.dist-info}/zip-safe +0 -0
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
shaped/autogen/models/encoder.py
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
shaped/autogen/models/engine.py
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -19,7 +18,7 @@ import json
|
|
|
19
18
|
|
|
20
19
|
from pydantic import BaseModel, ConfigDict, Field
|
|
21
20
|
from typing import Any, ClassVar, Dict, List
|
|
22
|
-
from shaped.autogen.models.
|
|
21
|
+
from shaped.autogen.models.user_inner import UserInner
|
|
23
22
|
from typing import Optional, Set
|
|
24
23
|
from typing_extensions import Self
|
|
25
24
|
|
|
@@ -27,9 +26,9 @@ class EngineSchema(BaseModel):
|
|
|
27
26
|
"""
|
|
28
27
|
EngineSchema
|
|
29
28
|
""" # noqa: E501
|
|
30
|
-
user: List[
|
|
31
|
-
item: List[
|
|
32
|
-
interaction: List[
|
|
29
|
+
user: List[UserInner] = Field(description="User features and labels in the engine schema.")
|
|
30
|
+
item: List[UserInner] = Field(description="Item features and labels in the engine schema.")
|
|
31
|
+
interaction: List[UserInner] = Field(description="Interaction features and labels in the engine schema.")
|
|
33
32
|
__properties: ClassVar[List[str]] = ["user", "item", "interaction"]
|
|
34
33
|
|
|
35
34
|
model_config = ConfigDict(
|
|
@@ -104,9 +103,9 @@ class EngineSchema(BaseModel):
|
|
|
104
103
|
return cls.model_validate(obj)
|
|
105
104
|
|
|
106
105
|
_obj = cls.model_validate({
|
|
107
|
-
"user": [
|
|
108
|
-
"item": [
|
|
109
|
-
"interaction": [
|
|
106
|
+
"user": [UserInner.from_dict(_item) for _item in obj["user"]] if obj.get("user") is not None else None,
|
|
107
|
+
"item": [UserInner.from_dict(_item) for _item in obj["item"]] if obj.get("item") is not None else None,
|
|
108
|
+
"interaction": [UserInner.from_dict(_item) for _item in obj["interaction"]] if obj.get("interaction") is not None else None
|
|
110
109
|
})
|
|
111
110
|
return _obj
|
|
112
111
|
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -19,6 +18,8 @@ import json
|
|
|
19
18
|
|
|
20
19
|
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
|
|
21
20
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
21
|
+
from shaped.autogen.models.inner_entity_id import InnerEntityId
|
|
22
|
+
from shaped.autogen.models.retrieval_scores_value import RetrievalScoresValue
|
|
22
23
|
from typing import Optional, Set
|
|
23
24
|
from typing_extensions import Self
|
|
24
25
|
|
|
@@ -27,18 +28,17 @@ class EntityJourney(BaseModel):
|
|
|
27
28
|
Tracks a single entity's journey through the query pipeline. Shows which retrievers found it, scores at each stage, filtering/reordering impact, and final position. Used in RankQueryConfig queries for both items and users.
|
|
28
29
|
""" # noqa: E501
|
|
29
30
|
entity_id: StrictStr = Field(description="External entity identifier (item_id or user_id as a string). This is the original ID format from your dataset.")
|
|
30
|
-
inner_entity_id: Optional[
|
|
31
|
+
inner_entity_id: Optional[InnerEntityId] = None
|
|
31
32
|
retrieved_by: Optional[List[StrictStr]] = Field(default=None, description="List of retrieval step names that found this entity. Shows which retrievers contributed this entity to the candidate set.")
|
|
32
|
-
retrieval_scores: Optional[Dict[str,
|
|
33
|
+
retrieval_scores: Optional[Dict[str, Optional[RetrievalScoresValue]]] = Field(default=None, description="Scores from each retrieval step. Dictionary mapping step names to their scores for this entity.")
|
|
33
34
|
retrieval_rank: Optional[Dict[str, StrictInt]] = Field(default=None, description="Rank position from each retrieval step. Dictionary mapping step names to their rank positions for this entity.")
|
|
34
35
|
filter_results: Optional[Dict[str, StrictBool]] = Field(default=None, description="Results from each filter step. Dictionary mapping filter step names to whether this entity passed (true) or failed (false) the filter.")
|
|
35
36
|
filtered_out_by: Optional[StrictStr] = None
|
|
36
37
|
score: Optional[Union[StrictFloat, StrictInt]] = None
|
|
37
38
|
score_rank: Optional[StrictInt] = None
|
|
38
|
-
reorder_changes: Optional[List[
|
|
39
|
+
reorder_changes: Optional[List[Dict[str, Any]]] = None
|
|
39
40
|
final_position: Optional[StrictInt] = None
|
|
40
41
|
final_score: Optional[Union[StrictFloat, StrictInt]] = None
|
|
41
|
-
additional_properties: Dict[str, Any] = {}
|
|
42
42
|
__properties: ClassVar[List[str]] = ["entity_id", "inner_entity_id", "retrieved_by", "retrieval_scores", "retrieval_rank", "filter_results", "filtered_out_by", "score", "score_rank", "reorder_changes", "final_position", "final_score"]
|
|
43
43
|
|
|
44
44
|
model_config = ConfigDict(
|
|
@@ -71,10 +71,8 @@ class EntityJourney(BaseModel):
|
|
|
71
71
|
* `None` is only added to the output dict for nullable fields that
|
|
72
72
|
were set at model initialization. Other fields with value `None`
|
|
73
73
|
are ignored.
|
|
74
|
-
* Fields in `self.additional_properties` are added to the output dict.
|
|
75
74
|
"""
|
|
76
75
|
excluded_fields: Set[str] = set([
|
|
77
|
-
"additional_properties",
|
|
78
76
|
])
|
|
79
77
|
|
|
80
78
|
_dict = self.model_dump(
|
|
@@ -82,11 +80,16 @@ class EntityJourney(BaseModel):
|
|
|
82
80
|
exclude=excluded_fields,
|
|
83
81
|
exclude_none=True,
|
|
84
82
|
)
|
|
85
|
-
#
|
|
86
|
-
if self.
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
83
|
+
# override the default output from pydantic by calling `to_dict()` of inner_entity_id
|
|
84
|
+
if self.inner_entity_id:
|
|
85
|
+
_dict['inner_entity_id'] = self.inner_entity_id.to_dict()
|
|
86
|
+
# override the default output from pydantic by calling `to_dict()` of each value in retrieval_scores (dict)
|
|
87
|
+
_field_dict = {}
|
|
88
|
+
if self.retrieval_scores:
|
|
89
|
+
for _key_retrieval_scores in self.retrieval_scores:
|
|
90
|
+
if self.retrieval_scores[_key_retrieval_scores]:
|
|
91
|
+
_field_dict[_key_retrieval_scores] = self.retrieval_scores[_key_retrieval_scores].to_dict()
|
|
92
|
+
_dict['retrieval_scores'] = _field_dict
|
|
90
93
|
# set to None if inner_entity_id (nullable) is None
|
|
91
94
|
# and model_fields_set contains the field
|
|
92
95
|
if self.inner_entity_id is None and "inner_entity_id" in self.model_fields_set:
|
|
@@ -107,6 +110,11 @@ class EntityJourney(BaseModel):
|
|
|
107
110
|
if self.score_rank is None and "score_rank" in self.model_fields_set:
|
|
108
111
|
_dict['score_rank'] = None
|
|
109
112
|
|
|
113
|
+
# set to None if reorder_changes (nullable) is None
|
|
114
|
+
# and model_fields_set contains the field
|
|
115
|
+
if self.reorder_changes is None and "reorder_changes" in self.model_fields_set:
|
|
116
|
+
_dict['reorder_changes'] = None
|
|
117
|
+
|
|
110
118
|
# set to None if final_position (nullable) is None
|
|
111
119
|
# and model_fields_set contains the field
|
|
112
120
|
if self.final_position is None and "final_position" in self.model_fields_set:
|
|
@@ -130,9 +138,14 @@ class EntityJourney(BaseModel):
|
|
|
130
138
|
|
|
131
139
|
_obj = cls.model_validate({
|
|
132
140
|
"entity_id": obj.get("entity_id"),
|
|
133
|
-
"inner_entity_id": obj.get("inner_entity_id"),
|
|
141
|
+
"inner_entity_id": InnerEntityId.from_dict(obj["inner_entity_id"]) if obj.get("inner_entity_id") is not None else None,
|
|
134
142
|
"retrieved_by": obj.get("retrieved_by"),
|
|
135
|
-
"retrieval_scores":
|
|
143
|
+
"retrieval_scores": dict(
|
|
144
|
+
(_k, RetrievalScoresValue.from_dict(_v))
|
|
145
|
+
for _k, _v in obj["retrieval_scores"].items()
|
|
146
|
+
)
|
|
147
|
+
if obj.get("retrieval_scores") is not None
|
|
148
|
+
else None,
|
|
136
149
|
"retrieval_rank": obj.get("retrieval_rank"),
|
|
137
150
|
"filter_results": obj.get("filter_results"),
|
|
138
151
|
"filtered_out_by": obj.get("filtered_out_by"),
|
|
@@ -142,11 +155,6 @@ class EntityJourney(BaseModel):
|
|
|
142
155
|
"final_position": obj.get("final_position"),
|
|
143
156
|
"final_score": obj.get("final_score")
|
|
144
157
|
})
|
|
145
|
-
# store additional fields in additional_properties
|
|
146
|
-
for _key in obj.keys():
|
|
147
|
-
if _key not in cls.__properties:
|
|
148
|
-
_obj.additional_properties[_key] = obj.get(_key)
|
|
149
|
-
|
|
150
158
|
return _obj
|
|
151
159
|
|
|
152
160
|
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# coding: utf-8
|
|
2
2
|
|
|
3
3
|
"""
|
|
4
|
-
|
|
4
|
+
Shaped API
|
|
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
|
-
|
|
9
|
-
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
9
|
|
|
11
|
-
|
|
12
|
-
"""
|
|
10
|
+
Do not edit the class manually.
|
|
11
|
+
""" # noqa: E501
|
|
13
12
|
|
|
14
13
|
|
|
15
14
|
from __future__ import annotations
|