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.
- shaped/__init__.py +47 -42
- shaped/autogen/__init__.py +37 -51
- shaped/autogen/api/engine_api.py +1 -1
- shaped/autogen/api/query_api.py +8 -68
- shaped/autogen/api/table_api.py +1 -1
- shaped/autogen/api/view_api.py +1 -1
- shaped/autogen/api_client.py +4 -4
- shaped/autogen/configuration.py +5 -3
- shaped/autogen/exceptions.py +7 -4
- shaped/autogen/models/__init__.py +19 -26
- shaped/autogen/models/ai_enrichment_view_config.py +1 -1
- shaped/autogen/models/algorithm.py +1 -1
- shaped/autogen/models/amplitude_table_config.py +1 -1
- shaped/autogen/models/ascending.py +29 -17
- shaped/autogen/models/attn_dropout_prob.py +1 -1
- shaped/autogen/models/attribute_journey.py +1 -1
- shaped/autogen/models/attribute_value.py +1 -1
- shaped/autogen/models/autoscaling_config.py +1 -1
- shaped/autogen/models/aws_pinpoint_table_config.py +1 -1
- shaped/autogen/models/batch_size.py +1 -1
- shaped/autogen/models/batch_size1.py +1 -1
- shaped/autogen/models/batch_size2.py +1 -1
- shaped/autogen/models/big_query_table_config.py +1 -1
- shaped/autogen/models/bm25.py +1 -1
- shaped/autogen/models/boosted_reorder_step.py +1 -1
- shaped/autogen/models/canary_rollout.py +1 -1
- shaped/autogen/models/candidate_attributes_retrieve_step.py +1 -14
- shaped/autogen/models/candidate_ids_retrieve_step.py +1 -1
- shaped/autogen/models/candidate_retrieval_strategy.py +1 -1
- shaped/autogen/models/clickhouse_table_config.py +1 -1
- shaped/autogen/models/column_order_retrieve_step.py +1 -1
- shaped/autogen/models/column_ordering.py +1 -1
- shaped/autogen/models/create_table_response.py +1 -1
- shaped/autogen/models/create_view_response.py +1 -1
- shaped/autogen/models/custom_table_config.py +1 -1
- shaped/autogen/models/data_compute_config.py +1 -1
- shaped/autogen/models/data_config.py +1 -1
- shaped/autogen/models/data_config_interaction_table.py +1 -1
- shaped/autogen/models/data_split_config.py +1 -1
- shaped/autogen/models/data_split_strategy.py +1 -1
- shaped/autogen/models/data_tier.py +1 -1
- shaped/autogen/models/default.py +1 -1
- shaped/autogen/models/delete_engine_response.py +1 -1
- shaped/autogen/models/delete_table_response.py +1 -1
- shaped/autogen/models/delete_view_response.py +1 -1
- shaped/autogen/models/deployment_config.py +2 -8
- shaped/autogen/models/distance_function.py +5 -5
- shaped/autogen/models/diversity_reorder_step.py +1 -1
- shaped/autogen/models/dropout_rate.py +1 -1
- shaped/autogen/models/dynamo_db_table_config.py +1 -1
- shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +1 -1
- shaped/autogen/models/embedder_batch_size.py +1 -1
- shaped/autogen/models/embedding_config.py +1 -1
- shaped/autogen/models/embedding_dim.py +1 -1
- shaped/autogen/models/embedding_dims.py +1 -1
- shaped/autogen/models/embedding_size.py +1 -1
- shaped/autogen/models/encoder.py +1 -1
- shaped/autogen/models/encoding_pooling_strategy.py +5 -5
- shaped/autogen/models/engine.py +1 -1
- shaped/autogen/models/engine_config_v2.py +1 -1
- shaped/autogen/models/engine_details_response.py +1 -1
- shaped/autogen/models/engine_schema.py +8 -8
- shaped/autogen/models/engine_schema_user_inner.py +30 -18
- shaped/autogen/models/entity_config.py +1 -1
- shaped/autogen/models/entity_journey.py +28 -19
- shaped/autogen/models/entity_type.py +1 -1
- shaped/autogen/models/evaluation_config.py +1 -1
- shaped/autogen/models/exploration_reorder_step.py +1 -1
- shaped/autogen/models/expression_filter_step.py +1 -1
- shaped/autogen/models/factors.py +1 -1
- shaped/autogen/models/factors1.py +1 -1
- shaped/autogen/models/feature.py +1 -1
- shaped/autogen/models/feature_type.py +1 -1
- shaped/autogen/models/file_table_config.py +1 -1
- shaped/autogen/models/filter_config.py +14 -14
- shaped/autogen/models/filter_dataset.py +47 -23
- shaped/autogen/models/filter_index_type.py +1 -1
- shaped/autogen/models/filter_retrieve_step.py +1 -1
- shaped/autogen/models/filter_step_explanation.py +165 -0
- shaped/autogen/models/filter_table.py +140 -0
- shaped/autogen/models/filter_type.py +134 -0
- shaped/autogen/models/global_filter.py +1 -1
- shaped/autogen/models/hidden_dropout_prob.py +1 -1
- shaped/autogen/models/hidden_size.py +1 -1
- shaped/autogen/models/hidden_size1.py +1 -1
- shaped/autogen/models/http_problem_response.py +1 -1
- shaped/autogen/models/http_validation_error.py +1 -1
- shaped/autogen/models/hugging_face_encoder.py +6 -4
- shaped/autogen/models/iceberg_table_config.py +1 -1
- shaped/autogen/models/index_config.py +1 -1
- shaped/autogen/models/inner_entity_id.py +144 -0
- shaped/autogen/models/inner_size.py +1 -1
- shaped/autogen/models/inner_size1.py +1 -1
- shaped/autogen/models/inner_uid.py +144 -0
- shaped/autogen/models/interaction_config.py +1 -1
- shaped/autogen/models/interaction_pooling_encoder.py +1 -1
- shaped/autogen/models/interaction_round_robin_encoder.py +1 -1
- shaped/autogen/models/item_attribute_pooling_encoder.py +1 -14
- shaped/autogen/models/journey.py +1 -1
- shaped/autogen/models/kafka_table_config.py +1 -1
- shaped/autogen/models/kinesis_table_config.py +1 -1
- shaped/autogen/models/kinesis_table_config_column_schema_value.py +1 -1
- shaped/autogen/models/label.py +1 -1
- shaped/autogen/models/label_type.py +1 -2
- shaped/autogen/models/laplace_smoothing.py +1 -1
- shaped/autogen/models/latency_scaling_policy.py +1 -1
- shaped/autogen/models/learning_rate.py +1 -1
- shaped/autogen/models/learning_rate1.py +1 -1
- shaped/autogen/models/learning_rate2.py +1 -1
- shaped/autogen/models/learning_rate3.py +1 -1
- shaped/autogen/models/lexical_search_mode.py +3 -3
- shaped/autogen/models/list_engines_response.py +1 -1
- shaped/autogen/models/list_tables_response.py +1 -1
- shaped/autogen/models/list_views_response.py +1 -1
- shaped/autogen/models/location_inner.py +138 -0
- shaped/autogen/models/loss_types.py +1 -1
- shaped/autogen/models/lr.py +1 -1
- shaped/autogen/models/lr1.py +1 -1
- shaped/autogen/models/lr2.py +1 -1
- shaped/autogen/models/max_depth.py +1 -1
- shaped/autogen/models/max_leaves.py +1 -1
- shaped/autogen/models/max_seq_length.py +1 -1
- shaped/autogen/models/max_seq_length1.py +1 -1
- shaped/autogen/models/max_seq_length2.py +1 -1
- shaped/autogen/models/mode.py +1 -1
- shaped/autogen/models/mode1.py +20 -18
- shaped/autogen/models/mode2.py +32 -18
- shaped/autogen/models/models_inner.py +308 -0
- shaped/autogen/models/mongo_db_table_config.py +1 -1
- shaped/autogen/models/mssql_table_config.py +1 -1
- shaped/autogen/models/my_sql_table_config.py +1 -1
- shaped/autogen/models/n_epochs.py +1 -1
- shaped/autogen/models/n_epochs1.py +1 -1
- shaped/autogen/models/n_epochs2.py +1 -1
- shaped/autogen/models/n_estimators.py +1 -1
- shaped/autogen/models/n_heads.py +1 -1
- shaped/autogen/models/n_layers.py +1 -1
- shaped/autogen/models/neg_per_positive.py +1 -1
- shaped/autogen/models/negative_samples_count.py +1 -1
- shaped/autogen/models/ngram_tokenizer.py +1 -1
- shaped/autogen/models/no_op_config.py +1 -1
- shaped/autogen/models/num_blocks.py +1 -1
- shaped/autogen/models/num_heads.py +1 -1
- shaped/autogen/models/num_leaves.py +1 -1
- shaped/autogen/models/objective.py +1 -1
- shaped/autogen/models/objective1.py +1 -1
- shaped/autogen/models/online_store_config.py +1 -1
- shaped/autogen/models/pagination_config.py +1 -1
- shaped/autogen/models/parameter_definition.py +1 -1
- shaped/autogen/models/parameters_value.py +1 -1
- shaped/autogen/models/passthrough_score.py +1 -1
- shaped/autogen/models/personal_filter.py +1 -1
- shaped/autogen/models/pipeline_stage_explanation.py +4 -4
- shaped/autogen/models/policy.py +1 -1
- shaped/autogen/models/pool_fn.py +39 -21
- shaped/autogen/models/pooling_function.py +1 -1
- shaped/autogen/models/postgres_table_config.py +1 -1
- shaped/autogen/models/posthog_table_config.py +1 -1
- shaped/autogen/models/prebuilt_filter_step.py +1 -1
- shaped/autogen/models/precomputed_item_embedding.py +1 -1
- shaped/autogen/models/precomputed_user_embedding.py +1 -1
- shaped/autogen/models/query.py +15 -15
- shaped/autogen/models/query1.py +15 -15
- shaped/autogen/models/query_any_of.py +58 -26
- shaped/autogen/models/query_config.py +140 -0
- shaped/autogen/models/query_definition.py +1 -1
- shaped/autogen/models/query_encoder.py +1 -1
- shaped/autogen/models/query_explanation.py +7 -3
- shaped/autogen/models/query_request.py +1 -1
- shaped/autogen/models/query_result.py +1 -1
- shaped/autogen/models/query_table_config.py +1 -1
- shaped/autogen/models/rank_item_attribute_values_query_config.py +1 -1
- shaped/autogen/models/rank_query_config.py +7 -7
- shaped/autogen/models/rank_query_config_filter_inner.py +1 -1
- shaped/autogen/models/rank_query_config_reorder_inner.py +62 -25
- shaped/autogen/models/rank_query_config_retrieve_inner.py +100 -31
- shaped/autogen/models/recreate_rollout.py +1 -1
- shaped/autogen/models/redshift_table_config.py +1 -1
- shaped/autogen/models/reference_table_config.py +1 -1
- shaped/autogen/models/regularization.py +1 -1
- shaped/autogen/models/reorder_inner.py +149 -0
- shaped/autogen/models/reorder_step_explanation.py +207 -0
- shaped/autogen/models/request.py +1 -1
- shaped/autogen/models/request1.py +1 -1
- shaped/autogen/models/requests_per_second_scaling_policy.py +1 -1
- shaped/autogen/models/resource_config.py +100 -0
- shaped/autogen/models/response_get_view_details_views_view_name_get.py +1 -1
- shaped/autogen/models/result.py +1 -14
- shaped/autogen/models/result_embeddings_value.py +1 -1
- shaped/autogen/models/retrieval_scores_value.py +127 -0
- shaped/autogen/models/retrieve_inner.py +196 -0
- shaped/autogen/models/retrieve_step_explanation.py +172 -0
- shaped/autogen/models/retriever.py +1 -1
- shaped/autogen/models/retriever1.py +1 -1
- shaped/autogen/models/rollout_config.py +1 -1
- shaped/autogen/models/rudderstack_table_config.py +1 -1
- shaped/autogen/models/sampling_strategy.py +1 -1
- shaped/autogen/models/saved_query_info_response.py +18 -4
- shaped/autogen/models/saved_query_list_response.py +1 -1
- shaped/autogen/models/saved_query_request.py +1 -1
- shaped/autogen/models/schema_config.py +1 -1
- shaped/autogen/models/score.py +1 -1
- shaped/autogen/models/score_ensemble.py +1 -14
- shaped/autogen/models/score_ensemble_policy_config.py +49 -25
- shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +456 -123
- shaped/autogen/models/score_step_explanation.py +224 -0
- shaped/autogen/models/search_config.py +1 -1
- shaped/autogen/models/segment_table_config.py +1 -1
- shaped/autogen/models/sequence_length.py +1 -1
- shaped/autogen/models/server_config.py +14 -1
- shaped/autogen/models/setup_engine_response.py +1 -1
- shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +9 -3
- shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +9 -3
- shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +10 -4
- shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +46 -27
- shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +6 -4
- shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +9 -3
- shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +1 -1
- shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +77 -34
- shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +9 -3
- shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +1 -1
- shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +52 -28
- shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +21 -17
- shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +36 -23
- shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +1 -1
- shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +9 -3
- shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +1 -1
- shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +9 -3
- shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +53 -31
- shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +10 -4
- shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +12 -6
- shaped/autogen/models/shopify_table_config.py +1 -1
- shaped/autogen/models/similarity_retrieve_step.py +6 -4
- shaped/autogen/models/snowflake_table_config.py +1 -1
- shaped/autogen/models/sql_transform_type.py +1 -1
- shaped/autogen/models/sql_view_config.py +1 -1
- shaped/autogen/models/stemmer_tokenizer.py +1 -1
- shaped/autogen/models/step_explanation.py +1 -1
- shaped/autogen/models/steps_inner.py +179 -0
- shaped/autogen/models/strategy.py +1 -1
- shaped/autogen/models/table.py +1 -1
- shaped/autogen/models/table_deployment_type.py +1 -1
- shaped/autogen/models/table_insert_arguments.py +3 -3
- shaped/autogen/models/table_insert_response.py +1 -1
- shaped/autogen/models/text_encoding.py +29 -17
- shaped/autogen/models/text_search_retrieve_step.py +1 -1
- shaped/autogen/models/time_frequency.py +1 -1
- shaped/autogen/models/time_window.py +1 -1
- shaped/autogen/models/time_window_in_days.py +29 -17
- shaped/autogen/models/tokenizer.py +1 -1
- shaped/autogen/models/trained_model_encoder.py +1 -1
- shaped/autogen/models/training_compute_config.py +4 -4
- shaped/autogen/models/training_config.py +4 -4
- shaped/autogen/models/training_config_models_inner.py +325 -93
- shaped/autogen/models/training_strategy.py +1 -1
- shaped/autogen/models/transform_status.py +41 -0
- shaped/autogen/models/trending_mode.py +4 -4
- shaped/autogen/models/truncate_filter_step.py +1 -1
- shaped/autogen/models/tunable_bool.py +1 -1
- shaped/autogen/models/tunable_float.py +1 -1
- shaped/autogen/models/tunable_int.py +1 -1
- shaped/autogen/models/tunable_int_categorical.py +1 -1
- shaped/autogen/models/tunable_string.py +1 -1
- shaped/autogen/models/tuning_config.py +1 -1
- shaped/autogen/models/type.py +36 -20
- shaped/autogen/models/update_table_response.py +1 -1
- shaped/autogen/models/update_view_response.py +1 -1
- shaped/autogen/models/user_attribute_pooling_encoder.py +1 -1
- shaped/autogen/models/user_inner.py +134 -0
- shaped/autogen/models/val_split.py +1 -1
- shaped/autogen/models/validation_error.py +4 -4
- shaped/autogen/models/validation_error_loc_inner.py +28 -16
- shaped/autogen/models/value_type.py +1 -1
- shaped/autogen/models/vector_search_mode.py +6 -4
- shaped/autogen/models/view.py +4 -4
- shaped/autogen/models/view_details_ai.py +6 -6
- shaped/autogen/models/view_details_ai_schema_value.py +1 -1
- shaped/autogen/models/view_details_sql.py +6 -6
- shaped/autogen/models/view_status.py +8 -8
- shaped/autogen/models/weight_decay.py +1 -1
- shaped/autogen/models/whitespace_tokenizer.py +1 -1
- shaped/autogen/models/window_size.py +1 -1
- shaped/autogen/rest.py +9 -9
- 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.4.dist-info}/METADATA +2 -2
- shaped-2.0.4.dist-info/RECORD +296 -0
- {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/WHEEL +1 -1
- shaped-2.0.2.dist-info/RECORD +0 -278
- {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/entry_points.txt +0 -0
- {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/top_level.txt +0 -0
- {shaped-2.0.2.dist-info → shaped-2.0.4.dist-info}/zip-safe +0 -0
shaped/autogen/models/query1.py
CHANGED
|
@@ -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.
|
|
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.
|
|
@@ -19,27 +19,27 @@ import pprint
|
|
|
19
19
|
import re # noqa: F401
|
|
20
20
|
from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
|
|
21
21
|
from typing import Optional
|
|
22
|
-
from shaped.autogen.models.
|
|
22
|
+
from shaped.autogen.models.query_config import QueryConfig
|
|
23
23
|
from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
|
|
24
24
|
from typing_extensions import Literal, Self
|
|
25
25
|
from pydantic import Field
|
|
26
26
|
|
|
27
|
-
QUERY1_ANY_OF_SCHEMAS = ["
|
|
27
|
+
QUERY1_ANY_OF_SCHEMAS = ["QueryConfig", "str"]
|
|
28
28
|
|
|
29
29
|
class Query1(BaseModel):
|
|
30
30
|
"""
|
|
31
31
|
Query configuration or SQL query string. Can be either: - A QueryConfig object defining the retrieval, filtering, scoring, and reordering pipeline. Must include a 'type' field indicating the query type (rank_items, rank_users, rerank_items, etc.). - A SQL query string that will be transpiled to a QueryConfig. Supports a subset of SQL with custom REORDER BY clause.
|
|
32
32
|
"""
|
|
33
33
|
|
|
34
|
-
# data type:
|
|
35
|
-
anyof_schema_1_validator: Optional[
|
|
34
|
+
# data type: QueryConfig
|
|
35
|
+
anyof_schema_1_validator: Optional[QueryConfig] = None
|
|
36
36
|
# data type: str
|
|
37
37
|
anyof_schema_2_validator: Optional[StrictStr] = None
|
|
38
38
|
if TYPE_CHECKING:
|
|
39
|
-
actual_instance: Optional[Union[
|
|
39
|
+
actual_instance: Optional[Union[QueryConfig, str]] = None
|
|
40
40
|
else:
|
|
41
41
|
actual_instance: Any = None
|
|
42
|
-
any_of_schemas: Set[str] = { "
|
|
42
|
+
any_of_schemas: Set[str] = { "QueryConfig", "str" }
|
|
43
43
|
|
|
44
44
|
model_config = {
|
|
45
45
|
"validate_assignment": True,
|
|
@@ -60,9 +60,9 @@ class Query1(BaseModel):
|
|
|
60
60
|
def actual_instance_must_validate_anyof(cls, v):
|
|
61
61
|
instance = Query1.model_construct()
|
|
62
62
|
error_messages = []
|
|
63
|
-
# validate data type:
|
|
64
|
-
if not isinstance(v,
|
|
65
|
-
error_messages.append(f"Error! Input type `{type(v)}` is not `
|
|
63
|
+
# validate data type: QueryConfig
|
|
64
|
+
if not isinstance(v, QueryConfig):
|
|
65
|
+
error_messages.append(f"Error! Input type `{type(v)}` is not `QueryConfig`")
|
|
66
66
|
else:
|
|
67
67
|
return v
|
|
68
68
|
|
|
@@ -74,7 +74,7 @@ class Query1(BaseModel):
|
|
|
74
74
|
error_messages.append(str(e))
|
|
75
75
|
if error_messages:
|
|
76
76
|
# no match
|
|
77
|
-
raise ValueError("No match found when setting the actual_instance in Query1 with anyOf schemas:
|
|
77
|
+
raise ValueError("No match found when setting the actual_instance in Query1 with anyOf schemas: QueryConfig, str. Details: " + ", ".join(error_messages))
|
|
78
78
|
else:
|
|
79
79
|
return v
|
|
80
80
|
|
|
@@ -87,9 +87,9 @@ class Query1(BaseModel):
|
|
|
87
87
|
"""Returns the object represented by the json string"""
|
|
88
88
|
instance = cls.model_construct()
|
|
89
89
|
error_messages = []
|
|
90
|
-
# anyof_schema_1_validator: Optional[
|
|
90
|
+
# anyof_schema_1_validator: Optional[QueryConfig] = None
|
|
91
91
|
try:
|
|
92
|
-
instance.actual_instance =
|
|
92
|
+
instance.actual_instance = QueryConfig.from_json(json_str)
|
|
93
93
|
return instance
|
|
94
94
|
except (ValidationError, ValueError) as e:
|
|
95
95
|
error_messages.append(str(e))
|
|
@@ -105,7 +105,7 @@ class Query1(BaseModel):
|
|
|
105
105
|
|
|
106
106
|
if error_messages:
|
|
107
107
|
# no match
|
|
108
|
-
raise ValueError("No match found when deserializing the JSON string into Query1 with anyOf schemas:
|
|
108
|
+
raise ValueError("No match found when deserializing the JSON string into Query1 with anyOf schemas: QueryConfig, str. Details: " + ", ".join(error_messages))
|
|
109
109
|
else:
|
|
110
110
|
return instance
|
|
111
111
|
|
|
@@ -119,7 +119,7 @@ class Query1(BaseModel):
|
|
|
119
119
|
else:
|
|
120
120
|
return json.dumps(self.actual_instance)
|
|
121
121
|
|
|
122
|
-
def to_dict(self) -> Optional[Union[Dict[str, Any],
|
|
122
|
+
def to_dict(self) -> Optional[Union[Dict[str, Any], QueryConfig, str]]:
|
|
123
123
|
"""Returns the dict representation of the actual instance"""
|
|
124
124
|
if self.actual_instance is None:
|
|
125
125
|
return None
|
|
@@ -13,69 +13,87 @@
|
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
from __future__ import annotations
|
|
16
|
+
|
|
16
17
|
import json
|
|
17
18
|
import pprint
|
|
18
|
-
from
|
|
19
|
-
|
|
20
|
-
from
|
|
19
|
+
from typing import Any, Dict, Optional, Set, Union
|
|
20
|
+
|
|
21
|
+
from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
|
|
22
|
+
from shaped.autogen.models.rank_item_attribute_values_query_config import (
|
|
23
|
+
RankItemAttributeValuesQueryConfig,
|
|
24
|
+
)
|
|
21
25
|
from shaped.autogen.models.rank_query_config import RankQueryConfig
|
|
22
|
-
from
|
|
23
|
-
from typing import Union, List, Set, Optional, Dict
|
|
24
|
-
from typing_extensions import Literal, Self
|
|
26
|
+
from typing_extensions import Self
|
|
25
27
|
|
|
26
28
|
QUERYANYOF_ONE_OF_SCHEMAS = ["RankItemAttributeValuesQueryConfig", "RankQueryConfig"]
|
|
27
29
|
|
|
30
|
+
|
|
28
31
|
class QueryAnyOf(BaseModel):
|
|
29
32
|
"""
|
|
30
33
|
QueryAnyOf
|
|
31
34
|
"""
|
|
35
|
+
|
|
32
36
|
# data type: RankQueryConfig
|
|
33
37
|
oneof_schema_1_validator: Optional[RankQueryConfig] = None
|
|
34
38
|
# data type: RankItemAttributeValuesQueryConfig
|
|
35
39
|
oneof_schema_2_validator: Optional[RankItemAttributeValuesQueryConfig] = None
|
|
36
|
-
actual_instance: Optional[
|
|
37
|
-
|
|
40
|
+
actual_instance: Optional[
|
|
41
|
+
Union[RankItemAttributeValuesQueryConfig, RankQueryConfig]
|
|
42
|
+
] = None
|
|
43
|
+
one_of_schemas: Set[str] = {"RankItemAttributeValuesQueryConfig", "RankQueryConfig"}
|
|
38
44
|
|
|
39
45
|
model_config = ConfigDict(
|
|
40
46
|
validate_assignment=True,
|
|
41
47
|
protected_namespaces=(),
|
|
42
48
|
)
|
|
43
49
|
|
|
44
|
-
|
|
45
|
-
discriminator_value_class_map: Dict[str, str] = {
|
|
46
|
-
}
|
|
50
|
+
discriminator_value_class_map: Dict[str, str] = {}
|
|
47
51
|
|
|
48
52
|
def __init__(self, *args, **kwargs) -> None:
|
|
49
53
|
if args:
|
|
50
54
|
if len(args) > 1:
|
|
51
|
-
raise ValueError(
|
|
55
|
+
raise ValueError(
|
|
56
|
+
"If a position argument is used, only 1 is allowed to set `actual_instance`"
|
|
57
|
+
)
|
|
52
58
|
if kwargs:
|
|
53
|
-
raise ValueError(
|
|
59
|
+
raise ValueError(
|
|
60
|
+
"If a position argument is used, keyword arguments cannot be used."
|
|
61
|
+
)
|
|
54
62
|
super().__init__(actual_instance=args[0])
|
|
55
63
|
else:
|
|
56
64
|
super().__init__(**kwargs)
|
|
57
65
|
|
|
58
|
-
@field_validator(
|
|
66
|
+
@field_validator("actual_instance")
|
|
59
67
|
def actual_instance_must_validate_oneof(cls, v):
|
|
60
68
|
instance = QueryAnyOf.model_construct()
|
|
61
69
|
error_messages = []
|
|
62
70
|
match = 0
|
|
63
71
|
# validate data type: RankQueryConfig
|
|
64
72
|
if not isinstance(v, RankQueryConfig):
|
|
65
|
-
error_messages.append(
|
|
73
|
+
error_messages.append(
|
|
74
|
+
f"Error! Input type `{type(v)}` is not `RankQueryConfig`"
|
|
75
|
+
)
|
|
66
76
|
else:
|
|
67
77
|
match += 1
|
|
68
78
|
# validate data type: RankItemAttributeValuesQueryConfig
|
|
69
79
|
if not isinstance(v, RankItemAttributeValuesQueryConfig):
|
|
70
|
-
error_messages.append(
|
|
80
|
+
error_messages.append(
|
|
81
|
+
f"Error! Input type `{type(v)}` is not `RankItemAttributeValuesQueryConfig`"
|
|
82
|
+
)
|
|
71
83
|
else:
|
|
72
84
|
match += 1
|
|
73
85
|
if match > 1:
|
|
74
86
|
# more than 1 match
|
|
75
|
-
raise ValueError(
|
|
87
|
+
raise ValueError(
|
|
88
|
+
"Multiple matches found when setting `actual_instance` in QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
|
|
89
|
+
+ ", ".join(error_messages)
|
|
90
|
+
)
|
|
76
91
|
elif match == 0:
|
|
77
92
|
# no match
|
|
78
|
-
raise ValueError(
|
|
93
|
+
raise ValueError(
|
|
94
|
+
"No match found when setting `actual_instance` in QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
|
|
95
|
+
+ ", ".join(error_messages)
|
|
96
|
+
)
|
|
79
97
|
else:
|
|
80
98
|
return v
|
|
81
99
|
|
|
@@ -98,17 +116,25 @@ class QueryAnyOf(BaseModel):
|
|
|
98
116
|
error_messages.append(str(e))
|
|
99
117
|
# deserialize data into RankItemAttributeValuesQueryConfig
|
|
100
118
|
try:
|
|
101
|
-
instance.actual_instance = RankItemAttributeValuesQueryConfig.from_json(
|
|
119
|
+
instance.actual_instance = RankItemAttributeValuesQueryConfig.from_json(
|
|
120
|
+
json_str
|
|
121
|
+
)
|
|
102
122
|
match += 1
|
|
103
123
|
except (ValidationError, ValueError) as e:
|
|
104
124
|
error_messages.append(str(e))
|
|
105
125
|
|
|
106
126
|
if match > 1:
|
|
107
127
|
# more than 1 match
|
|
108
|
-
raise ValueError(
|
|
128
|
+
raise ValueError(
|
|
129
|
+
"Multiple matches found when deserializing the JSON string into QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
|
|
130
|
+
+ ", ".join(error_messages)
|
|
131
|
+
)
|
|
109
132
|
elif match == 0:
|
|
110
133
|
# no match
|
|
111
|
-
raise ValueError(
|
|
134
|
+
raise ValueError(
|
|
135
|
+
"No match found when deserializing the JSON string into QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: "
|
|
136
|
+
+ ", ".join(error_messages)
|
|
137
|
+
)
|
|
112
138
|
else:
|
|
113
139
|
return instance
|
|
114
140
|
|
|
@@ -117,17 +143,25 @@ class QueryAnyOf(BaseModel):
|
|
|
117
143
|
if self.actual_instance is None:
|
|
118
144
|
return "null"
|
|
119
145
|
|
|
120
|
-
if hasattr(self.actual_instance, "to_json") and callable(
|
|
146
|
+
if hasattr(self.actual_instance, "to_json") and callable(
|
|
147
|
+
self.actual_instance.to_json
|
|
148
|
+
):
|
|
121
149
|
return self.actual_instance.to_json()
|
|
122
150
|
else:
|
|
123
151
|
return json.dumps(self.actual_instance)
|
|
124
152
|
|
|
125
|
-
def to_dict(
|
|
153
|
+
def to_dict(
|
|
154
|
+
self,
|
|
155
|
+
) -> Optional[
|
|
156
|
+
Union[Dict[str, Any], RankItemAttributeValuesQueryConfig, RankQueryConfig]
|
|
157
|
+
]:
|
|
126
158
|
"""Returns the dict representation of the actual instance"""
|
|
127
159
|
if self.actual_instance is None:
|
|
128
160
|
return None
|
|
129
161
|
|
|
130
|
-
if hasattr(self.actual_instance, "to_dict") and callable(
|
|
162
|
+
if hasattr(self.actual_instance, "to_dict") and callable(
|
|
163
|
+
self.actual_instance.to_dict
|
|
164
|
+
):
|
|
131
165
|
return self.actual_instance.to_dict()
|
|
132
166
|
else:
|
|
133
167
|
# primitive type
|
|
@@ -136,5 +170,3 @@ class QueryAnyOf(BaseModel):
|
|
|
136
170
|
def to_str(self) -> str:
|
|
137
171
|
"""Returns the string representation of the actual instance"""
|
|
138
172
|
return pprint.pformat(self.model_dump())
|
|
139
|
-
|
|
140
|
-
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Shaped API
|
|
5
|
+
|
|
6
|
+
Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.0.4
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
import json
|
|
17
|
+
import pprint
|
|
18
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
|
|
19
|
+
from typing import Any, List, Optional
|
|
20
|
+
from shaped.autogen.models.rank_item_attribute_values_query_config import RankItemAttributeValuesQueryConfig
|
|
21
|
+
from shaped.autogen.models.rank_query_config import RankQueryConfig
|
|
22
|
+
from pydantic import StrictStr, Field
|
|
23
|
+
from typing import Union, List, Set, Optional, Dict
|
|
24
|
+
from typing_extensions import Literal, Self
|
|
25
|
+
|
|
26
|
+
QUERYCONFIG_ONE_OF_SCHEMAS = ["RankItemAttributeValuesQueryConfig", "RankQueryConfig"]
|
|
27
|
+
|
|
28
|
+
class QueryConfig(BaseModel):
|
|
29
|
+
"""
|
|
30
|
+
QueryConfig
|
|
31
|
+
"""
|
|
32
|
+
# data type: RankQueryConfig
|
|
33
|
+
oneof_schema_1_validator: Optional[RankQueryConfig] = None
|
|
34
|
+
# data type: RankItemAttributeValuesQueryConfig
|
|
35
|
+
oneof_schema_2_validator: Optional[RankItemAttributeValuesQueryConfig] = None
|
|
36
|
+
actual_instance: Optional[Union[RankItemAttributeValuesQueryConfig, RankQueryConfig]] = None
|
|
37
|
+
one_of_schemas: Set[str] = { "RankItemAttributeValuesQueryConfig", "RankQueryConfig" }
|
|
38
|
+
|
|
39
|
+
model_config = ConfigDict(
|
|
40
|
+
validate_assignment=True,
|
|
41
|
+
protected_namespaces=(),
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
discriminator_value_class_map: Dict[str, str] = {
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
def __init__(self, *args, **kwargs) -> None:
|
|
49
|
+
if args:
|
|
50
|
+
if len(args) > 1:
|
|
51
|
+
raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
|
|
52
|
+
if kwargs:
|
|
53
|
+
raise ValueError("If a position argument is used, keyword arguments cannot be used.")
|
|
54
|
+
super().__init__(actual_instance=args[0])
|
|
55
|
+
else:
|
|
56
|
+
super().__init__(**kwargs)
|
|
57
|
+
|
|
58
|
+
@field_validator('actual_instance')
|
|
59
|
+
def actual_instance_must_validate_oneof(cls, v):
|
|
60
|
+
instance = QueryConfig.model_construct()
|
|
61
|
+
error_messages = []
|
|
62
|
+
match = 0
|
|
63
|
+
# validate data type: RankQueryConfig
|
|
64
|
+
if not isinstance(v, RankQueryConfig):
|
|
65
|
+
error_messages.append(f"Error! Input type `{type(v)}` is not `RankQueryConfig`")
|
|
66
|
+
else:
|
|
67
|
+
match += 1
|
|
68
|
+
# validate data type: RankItemAttributeValuesQueryConfig
|
|
69
|
+
if not isinstance(v, RankItemAttributeValuesQueryConfig):
|
|
70
|
+
error_messages.append(f"Error! Input type `{type(v)}` is not `RankItemAttributeValuesQueryConfig`")
|
|
71
|
+
else:
|
|
72
|
+
match += 1
|
|
73
|
+
if match > 1:
|
|
74
|
+
# more than 1 match
|
|
75
|
+
raise ValueError("Multiple matches found when setting `actual_instance` in QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
|
|
76
|
+
elif match == 0:
|
|
77
|
+
# no match
|
|
78
|
+
raise ValueError("No match found when setting `actual_instance` in QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
|
|
79
|
+
else:
|
|
80
|
+
return v
|
|
81
|
+
|
|
82
|
+
@classmethod
|
|
83
|
+
def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
|
|
84
|
+
return cls.from_json(json.dumps(obj))
|
|
85
|
+
|
|
86
|
+
@classmethod
|
|
87
|
+
def from_json(cls, json_str: str) -> Self:
|
|
88
|
+
"""Returns the object represented by the json string"""
|
|
89
|
+
instance = cls.model_construct()
|
|
90
|
+
error_messages = []
|
|
91
|
+
match = 0
|
|
92
|
+
|
|
93
|
+
# deserialize data into RankQueryConfig
|
|
94
|
+
try:
|
|
95
|
+
instance.actual_instance = RankQueryConfig.from_json(json_str)
|
|
96
|
+
match += 1
|
|
97
|
+
except (ValidationError, ValueError) as e:
|
|
98
|
+
error_messages.append(str(e))
|
|
99
|
+
# deserialize data into RankItemAttributeValuesQueryConfig
|
|
100
|
+
try:
|
|
101
|
+
instance.actual_instance = RankItemAttributeValuesQueryConfig.from_json(json_str)
|
|
102
|
+
match += 1
|
|
103
|
+
except (ValidationError, ValueError) as e:
|
|
104
|
+
error_messages.append(str(e))
|
|
105
|
+
|
|
106
|
+
if match > 1:
|
|
107
|
+
# more than 1 match
|
|
108
|
+
raise ValueError("Multiple matches found when deserializing the JSON string into QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
|
|
109
|
+
elif match == 0:
|
|
110
|
+
# no match
|
|
111
|
+
raise ValueError("No match found when deserializing the JSON string into QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
|
|
112
|
+
else:
|
|
113
|
+
return instance
|
|
114
|
+
|
|
115
|
+
def to_json(self) -> str:
|
|
116
|
+
"""Returns the JSON representation of the actual instance"""
|
|
117
|
+
if self.actual_instance is None:
|
|
118
|
+
return "null"
|
|
119
|
+
|
|
120
|
+
if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
|
|
121
|
+
return self.actual_instance.to_json()
|
|
122
|
+
else:
|
|
123
|
+
return json.dumps(self.actual_instance)
|
|
124
|
+
|
|
125
|
+
def to_dict(self) -> Optional[Union[Dict[str, Any], RankItemAttributeValuesQueryConfig, RankQueryConfig]]:
|
|
126
|
+
"""Returns the dict representation of the actual instance"""
|
|
127
|
+
if self.actual_instance is None:
|
|
128
|
+
return None
|
|
129
|
+
|
|
130
|
+
if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
|
|
131
|
+
return self.actual_instance.to_dict()
|
|
132
|
+
else:
|
|
133
|
+
# primitive type
|
|
134
|
+
return self.actual_instance
|
|
135
|
+
|
|
136
|
+
def to_str(self) -> str:
|
|
137
|
+
"""Returns the string representation of the actual instance"""
|
|
138
|
+
return pprint.pformat(self.model_dump())
|
|
139
|
+
|
|
140
|
+
|
|
@@ -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.
|
|
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.
|
|
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.
|
|
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.
|
|
@@ -19,6 +19,7 @@ import json
|
|
|
19
19
|
|
|
20
20
|
from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
|
|
21
21
|
from typing import Any, ClassVar, Dict, List, Optional, Union
|
|
22
|
+
from shaped.autogen.models.inner_uid import InnerUid
|
|
22
23
|
from shaped.autogen.models.pipeline_stage_explanation import PipelineStageExplanation
|
|
23
24
|
from typing import Optional, Set
|
|
24
25
|
from typing_extensions import Self
|
|
@@ -38,7 +39,7 @@ class QueryExplanation(BaseModel):
|
|
|
38
39
|
total_execution_time_ms: Optional[Union[StrictFloat, StrictInt]] = None
|
|
39
40
|
final_result_count: Optional[StrictInt] = None
|
|
40
41
|
limit_applied: Optional[StrictInt] = None
|
|
41
|
-
inner_uid: Optional[
|
|
42
|
+
inner_uid: Optional[InnerUid] = None
|
|
42
43
|
outer_uid: Optional[StrictStr] = None
|
|
43
44
|
additional_properties: Dict[str, Any] = {}
|
|
44
45
|
__properties: ClassVar[List[str]] = ["query_name", "query_type", "parameters", "pagination_id", "retrieve_stage", "filter_stage", "score_stage", "reorder_stage", "total_execution_time_ms", "final_result_count", "limit_applied", "inner_uid", "outer_uid"]
|
|
@@ -96,6 +97,9 @@ class QueryExplanation(BaseModel):
|
|
|
96
97
|
# override the default output from pydantic by calling `to_dict()` of reorder_stage
|
|
97
98
|
if self.reorder_stage:
|
|
98
99
|
_dict['reorder_stage'] = self.reorder_stage.to_dict()
|
|
100
|
+
# override the default output from pydantic by calling `to_dict()` of inner_uid
|
|
101
|
+
if self.inner_uid:
|
|
102
|
+
_dict['inner_uid'] = self.inner_uid.to_dict()
|
|
99
103
|
# puts key-value pairs in additional_properties in the top level
|
|
100
104
|
if self.additional_properties is not None:
|
|
101
105
|
for _key, _value in self.additional_properties.items():
|
|
@@ -184,7 +188,7 @@ class QueryExplanation(BaseModel):
|
|
|
184
188
|
"total_execution_time_ms": obj.get("total_execution_time_ms"),
|
|
185
189
|
"final_result_count": obj.get("final_result_count"),
|
|
186
190
|
"limit_applied": obj.get("limit_applied"),
|
|
187
|
-
"inner_uid": obj.get("inner_uid"),
|
|
191
|
+
"inner_uid": InnerUid.from_dict(obj["inner_uid"]) if obj.get("inner_uid") is not None else None,
|
|
188
192
|
"outer_uid": obj.get("outer_uid")
|
|
189
193
|
})
|
|
190
194
|
# store additional fields in additional_properties
|
|
@@ -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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
@@ -21,8 +21,8 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_v
|
|
|
21
21
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
22
|
from shaped.autogen.models.entity_type import EntityType
|
|
23
23
|
from shaped.autogen.models.rank_query_config_filter_inner import RankQueryConfigFilterInner
|
|
24
|
-
from shaped.autogen.models.
|
|
25
|
-
from shaped.autogen.models.
|
|
24
|
+
from shaped.autogen.models.reorder_inner import ReorderInner
|
|
25
|
+
from shaped.autogen.models.retrieve_inner import RetrieveInner
|
|
26
26
|
from shaped.autogen.models.score import Score
|
|
27
27
|
from typing import Optional, Set
|
|
28
28
|
from typing_extensions import Self
|
|
@@ -33,10 +33,10 @@ class RankQueryConfig(BaseModel):
|
|
|
33
33
|
""" # noqa: E501
|
|
34
34
|
columns: Optional[List[StrictStr]] = None
|
|
35
35
|
embeddings: Optional[List[StrictStr]] = None
|
|
36
|
-
retrieve: Optional[List[
|
|
36
|
+
retrieve: Optional[List[RetrieveInner]] = Field(default=None, description="List of retrieval steps to execute.")
|
|
37
37
|
filter: Optional[List[RankQueryConfigFilterInner]] = None
|
|
38
38
|
score: Optional[Score] = None
|
|
39
|
-
reorder: Optional[List[
|
|
39
|
+
reorder: Optional[List[ReorderInner]] = Field(default=None, description="List of reordering steps to apply.")
|
|
40
40
|
limit: Optional[StrictInt] = None
|
|
41
41
|
type: Optional[StrictStr] = Field(default='rank', description="Query config type discriminator.")
|
|
42
42
|
var_from: Optional[EntityType] = Field(default=None, alias="from")
|
|
@@ -154,10 +154,10 @@ class RankQueryConfig(BaseModel):
|
|
|
154
154
|
_obj = cls.model_validate({
|
|
155
155
|
"columns": obj.get("columns"),
|
|
156
156
|
"embeddings": obj.get("embeddings"),
|
|
157
|
-
"retrieve": [
|
|
157
|
+
"retrieve": [RetrieveInner.from_dict(_item) for _item in obj["retrieve"]] if obj.get("retrieve") is not None else None,
|
|
158
158
|
"filter": [RankQueryConfigFilterInner.from_dict(_item) for _item in obj["filter"]] if obj.get("filter") is not None else None,
|
|
159
159
|
"score": Score.from_dict(obj["score"]) if obj.get("score") is not None else None,
|
|
160
|
-
"reorder": [
|
|
160
|
+
"reorder": [ReorderInner.from_dict(_item) for _item in obj["reorder"]] if obj.get("reorder") is not None else None,
|
|
161
161
|
"limit": obj.get("limit"),
|
|
162
162
|
"type": obj.get("type") if obj.get("type") is not None else 'rank',
|
|
163
163
|
"from": obj.get("from")
|
|
@@ -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.
|
|
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.
|