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
shaped/autogen/models/view.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
|
|
@@ -31,9 +30,9 @@ class View(BaseModel):
|
|
|
31
30
|
created_at: StrictStr = Field(description="ISO timestamp when view was created.")
|
|
32
31
|
type: StrictStr = Field(description="Type of view (SQL or AI_ENRICHMENT).")
|
|
33
32
|
status: StrictStr = Field(description="Current deployment status of the view.")
|
|
34
|
-
|
|
33
|
+
source_table_names: List[StrictStr] = Field(description="List of source table names used by this view.")
|
|
35
34
|
description: Optional[StrictStr] = None
|
|
36
|
-
__properties: ClassVar[List[str]] = ["name", "uri", "created_at", "type", "status", "
|
|
35
|
+
__properties: ClassVar[List[str]] = ["name", "uri", "created_at", "type", "status", "source_table_names", "description"]
|
|
37
36
|
|
|
38
37
|
model_config = ConfigDict(
|
|
39
38
|
populate_by_name=True,
|
|
@@ -96,7 +95,7 @@ class View(BaseModel):
|
|
|
96
95
|
"created_at": obj.get("created_at"),
|
|
97
96
|
"type": obj.get("type"),
|
|
98
97
|
"status": obj.get("status"),
|
|
99
|
-
"
|
|
98
|
+
"source_table_names": obj.get("source_table_names"),
|
|
100
99
|
"description": obj.get("description")
|
|
101
100
|
})
|
|
102
101
|
return _obj
|
|
@@ -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
|
|
@@ -20,8 +19,8 @@ import json
|
|
|
20
19
|
from datetime import datetime
|
|
21
20
|
from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
|
|
22
21
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from shaped.autogen.models.transform_status import TransformStatus
|
|
23
23
|
from shaped.autogen.models.view_details_ai_schema_value import ViewDetailsAISchemaValue
|
|
24
|
-
from shaped.autogen.models.view_status import ViewStatus
|
|
25
24
|
from typing import Optional, Set
|
|
26
25
|
from typing_extensions import Self
|
|
27
26
|
|
|
@@ -31,14 +30,14 @@ class ViewDetailsAI(BaseModel):
|
|
|
31
30
|
""" # noqa: E501
|
|
32
31
|
name: StrictStr = Field(description="Unique identifier for the view.")
|
|
33
32
|
uri: StrictStr = Field(description="URI to access the view.")
|
|
34
|
-
status:
|
|
33
|
+
status: TransformStatus = Field(description="Current deployment status.")
|
|
35
34
|
created_at: datetime = Field(description="Timestamp when view was created.")
|
|
36
35
|
var_schema: Optional[Dict[str, ViewDetailsAISchemaValue]] = Field(default=None, alias="schema")
|
|
37
|
-
|
|
36
|
+
source_table_names: List[StrictStr] = Field(description="List of source table names used by this view.")
|
|
38
37
|
description: Optional[StrictStr] = None
|
|
39
38
|
error_message: Optional[StrictStr] = None
|
|
40
39
|
type: StrictStr = Field(description="View type discriminator for AI enrichment views.")
|
|
41
|
-
__properties: ClassVar[List[str]] = ["name", "uri", "status", "created_at", "schema", "
|
|
40
|
+
__properties: ClassVar[List[str]] = ["name", "uri", "status", "created_at", "schema", "source_table_names", "description", "error_message", "type"]
|
|
42
41
|
|
|
43
42
|
@field_validator('type')
|
|
44
43
|
def type_validate_enum(cls, value):
|
|
@@ -130,7 +129,7 @@ class ViewDetailsAI(BaseModel):
|
|
|
130
129
|
)
|
|
131
130
|
if obj.get("schema") is not None
|
|
132
131
|
else None,
|
|
133
|
-
"
|
|
132
|
+
"source_table_names": obj.get("source_table_names"),
|
|
134
133
|
"description": obj.get("description"),
|
|
135
134
|
"error_message": obj.get("error_message"),
|
|
136
135
|
"type": obj.get("type")
|
|
@@ -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
|
|
@@ -20,8 +19,8 @@ import json
|
|
|
20
19
|
from datetime import datetime
|
|
21
20
|
from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
|
|
22
21
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from shaped.autogen.models.transform_status import TransformStatus
|
|
23
23
|
from shaped.autogen.models.view_details_ai_schema_value import ViewDetailsAISchemaValue
|
|
24
|
-
from shaped.autogen.models.view_status import ViewStatus
|
|
25
24
|
from typing import Optional, Set
|
|
26
25
|
from typing_extensions import Self
|
|
27
26
|
|
|
@@ -31,14 +30,14 @@ class ViewDetailsSQL(BaseModel):
|
|
|
31
30
|
""" # noqa: E501
|
|
32
31
|
name: StrictStr = Field(description="Unique identifier for the view.")
|
|
33
32
|
uri: StrictStr = Field(description="URI to access the view.")
|
|
34
|
-
status:
|
|
33
|
+
status: TransformStatus = Field(description="Current deployment status.")
|
|
35
34
|
created_at: datetime = Field(description="Timestamp when view was created.")
|
|
36
35
|
var_schema: Optional[Dict[str, ViewDetailsAISchemaValue]] = Field(default=None, alias="schema")
|
|
37
|
-
|
|
36
|
+
source_table_names: List[StrictStr] = Field(description="List of source table names used by this view.")
|
|
38
37
|
description: Optional[StrictStr] = None
|
|
39
38
|
error_message: Optional[StrictStr] = None
|
|
40
39
|
type: StrictStr = Field(description="View type discriminator for SQL views.")
|
|
41
|
-
__properties: ClassVar[List[str]] = ["name", "uri", "status", "created_at", "schema", "
|
|
40
|
+
__properties: ClassVar[List[str]] = ["name", "uri", "status", "created_at", "schema", "source_table_names", "description", "error_message", "type"]
|
|
42
41
|
|
|
43
42
|
@field_validator('type')
|
|
44
43
|
def type_validate_enum(cls, value):
|
|
@@ -130,7 +129,7 @@ class ViewDetailsSQL(BaseModel):
|
|
|
130
129
|
)
|
|
131
130
|
if obj.get("schema") is not None
|
|
132
131
|
else None,
|
|
133
|
-
"
|
|
132
|
+
"source_table_names": obj.get("source_table_names"),
|
|
134
133
|
"description": obj.get("description"),
|
|
135
134
|
"error_message": obj.get("error_message"),
|
|
136
135
|
"type": obj.get("type")
|
|
@@ -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/rest.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
|
import io
|
|
@@ -48,12 +47,17 @@ class RESTResponse(io.IOBase):
|
|
|
48
47
|
self.data = self.response.data
|
|
49
48
|
return self.data
|
|
50
49
|
|
|
50
|
+
@property
|
|
51
|
+
def headers(self):
|
|
52
|
+
"""Returns a dictionary of response headers."""
|
|
53
|
+
return self.response.headers
|
|
54
|
+
|
|
51
55
|
def getheaders(self):
|
|
52
|
-
"""Returns a dictionary of the response headers."""
|
|
56
|
+
"""Returns a dictionary of the response headers; use ``headers`` instead."""
|
|
53
57
|
return self.response.headers
|
|
54
58
|
|
|
55
59
|
def getheader(self, name, default=None):
|
|
56
|
-
"""Returns a given response header."""
|
|
60
|
+
"""Returns a given response header; use ``headers.get()`` instead."""
|
|
57
61
|
return self.response.headers.get(name, default)
|
|
58
62
|
|
|
59
63
|
|
|
@@ -76,13 +80,8 @@ class RESTClientObject:
|
|
|
76
80
|
"ca_certs": configuration.ssl_ca_cert,
|
|
77
81
|
"cert_file": configuration.cert_file,
|
|
78
82
|
"key_file": configuration.key_file,
|
|
83
|
+
"ca_cert_data": configuration.ca_cert_data,
|
|
79
84
|
}
|
|
80
|
-
# Only add ca_cert_data if urllib3 version supports it.
|
|
81
|
-
# urllib3 2.2+ may not support key_ca_cert_data parameter.
|
|
82
|
-
if configuration.ca_cert_data is not None:
|
|
83
|
-
# For urllib3 2.2+, use ca_certs or handle differently.
|
|
84
|
-
# Skip ca_cert_data to avoid PoolKey errors.
|
|
85
|
-
pass
|
|
86
85
|
if configuration.assert_hostname is not None:
|
|
87
86
|
pool_args['assert_hostname'] = (
|
|
88
87
|
configuration.assert_hostname
|
shaped/cli/shaped_cli.py
CHANGED
|
@@ -61,14 +61,79 @@ def _parse_response_as_yaml(content: str) -> str:
|
|
|
61
61
|
return yaml.dump(json.loads(content), sort_keys=False)
|
|
62
62
|
|
|
63
63
|
|
|
64
|
+
def _normalize_query_to_request(query_input: str) -> str:
|
|
65
|
+
"""
|
|
66
|
+
Normalize query input to a QueryRequest JSON string.
|
|
67
|
+
|
|
68
|
+
The input can be:
|
|
69
|
+
- A SQL string (e.g., "SELECT * FROM table")
|
|
70
|
+
- A QueryConfig JSON object (e.g., {"type": "rank", ...})
|
|
71
|
+
- A full QueryRequest JSON object (e.g., {"query": "...", "return_metadata": true})
|
|
72
|
+
- Legacy format (e.g., {"sql": "SELECT * FROM table"})
|
|
73
|
+
|
|
74
|
+
Returns a JSON string representing a QueryRequest.
|
|
75
|
+
|
|
76
|
+
Raises:
|
|
77
|
+
ValueError: If the input is invalid or cannot be normalized.
|
|
78
|
+
"""
|
|
79
|
+
if not query_input or not query_input.strip():
|
|
80
|
+
raise ValueError(
|
|
81
|
+
"Query input cannot be empty. Provide a SQL query string or "
|
|
82
|
+
"JSON query configuration."
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
# Try to parse as JSON first.
|
|
86
|
+
try:
|
|
87
|
+
parsed = json.loads(query_input)
|
|
88
|
+
|
|
89
|
+
# If it's already a QueryRequest (has 'query' field), use as-is.
|
|
90
|
+
if isinstance(parsed, dict) and "query" in parsed:
|
|
91
|
+
return json.dumps(parsed)
|
|
92
|
+
|
|
93
|
+
# Handle legacy {"sql": "..."} format.
|
|
94
|
+
if isinstance(parsed, dict) and "sql" in parsed:
|
|
95
|
+
sql_string = parsed["sql"]
|
|
96
|
+
if not isinstance(sql_string, str) or not sql_string.strip():
|
|
97
|
+
raise ValueError(
|
|
98
|
+
"Invalid 'sql' field in query. Expected a non-empty SQL string."
|
|
99
|
+
)
|
|
100
|
+
# Merge any other fields (like return_metadata) if present.
|
|
101
|
+
request = {"query": sql_string, "return_metadata": True}
|
|
102
|
+
if "return_metadata" in parsed:
|
|
103
|
+
request["return_metadata"] = parsed["return_metadata"]
|
|
104
|
+
if "parameters" in parsed:
|
|
105
|
+
request["parameters"] = parsed["parameters"]
|
|
106
|
+
return json.dumps(request)
|
|
107
|
+
|
|
108
|
+
# If it's a dict but not a QueryRequest, wrap it as the query field.
|
|
109
|
+
if isinstance(parsed, dict):
|
|
110
|
+
return json.dumps({"query": parsed, "return_metadata": True})
|
|
111
|
+
|
|
112
|
+
# If it's a string in JSON (unlikely but possible), treat as SQL.
|
|
113
|
+
if isinstance(parsed, str):
|
|
114
|
+
return json.dumps({"query": parsed, "return_metadata": True})
|
|
115
|
+
|
|
116
|
+
# Other types, wrap as query.
|
|
117
|
+
return json.dumps({"query": parsed, "return_metadata": True})
|
|
118
|
+
except json.JSONDecodeError:
|
|
119
|
+
# Not valid JSON, treat as SQL string.
|
|
120
|
+
# This is expected for plain SQL queries, so we don't raise an error.
|
|
121
|
+
return json.dumps({"query": query_input, "return_metadata": True})
|
|
122
|
+
except ValueError as e:
|
|
123
|
+
# Re-raise ValueError with context.
|
|
124
|
+
raise ValueError(f"Invalid query input: {e}") from e
|
|
125
|
+
|
|
126
|
+
|
|
64
127
|
@app.command()
|
|
65
128
|
def init(
|
|
66
129
|
api_key: str = typer.Option(..., "--api-key", help="Your Shaped API key."),
|
|
67
|
-
env: str = typer.Option(
|
|
130
|
+
env: str = typer.Option(
|
|
131
|
+
"prod", "--env", help="Environment to use (e.g., prod, dev, staging)."
|
|
132
|
+
),
|
|
68
133
|
):
|
|
69
134
|
"""
|
|
70
135
|
Initialize the Shaped CLI with your API key and environment.
|
|
71
|
-
|
|
136
|
+
|
|
72
137
|
This command saves your configuration locally so you don't need to
|
|
73
138
|
provide your API key for every command.
|
|
74
139
|
"""
|
|
@@ -81,6 +146,7 @@ def init(
|
|
|
81
146
|
# ENGINE API #
|
|
82
147
|
##############
|
|
83
148
|
|
|
149
|
+
|
|
84
150
|
@app.command()
|
|
85
151
|
def create_engine(
|
|
86
152
|
file: typer.FileText = typer.Option(
|
|
@@ -89,7 +155,7 @@ def create_engine(
|
|
|
89
155
|
):
|
|
90
156
|
"""
|
|
91
157
|
Create a new engine.
|
|
92
|
-
|
|
158
|
+
|
|
93
159
|
The engine configuration can be provided via:
|
|
94
160
|
- --file: Path to a JSON/YAML file
|
|
95
161
|
- stdin: Pipe JSON/YAML content
|
|
@@ -125,7 +191,7 @@ def update_engine(
|
|
|
125
191
|
):
|
|
126
192
|
"""
|
|
127
193
|
Update an existing engine.
|
|
128
|
-
|
|
194
|
+
|
|
129
195
|
The engine configuration can be provided via:
|
|
130
196
|
- --file: Path to a JSON/YAML file
|
|
131
197
|
- stdin: Pipe JSON/YAML content
|
|
@@ -218,7 +284,7 @@ def create_table_from_uri(
|
|
|
218
284
|
):
|
|
219
285
|
"""
|
|
220
286
|
Create a table from a data file and automatically insert the data.
|
|
221
|
-
|
|
287
|
+
|
|
222
288
|
The table schema is inferred from the first chunk of data.
|
|
223
289
|
"""
|
|
224
290
|
chunks = _read_chunks(path, type, chunk_size=1)
|
|
@@ -249,7 +315,7 @@ def create_table(
|
|
|
249
315
|
):
|
|
250
316
|
"""
|
|
251
317
|
Create a new table.
|
|
252
|
-
|
|
318
|
+
|
|
253
319
|
The table configuration can be provided via:
|
|
254
320
|
- --file: Path to a JSON/YAML file
|
|
255
321
|
- stdin: Pipe JSON/YAML content
|
|
@@ -321,7 +387,7 @@ def update_table(
|
|
|
321
387
|
):
|
|
322
388
|
"""
|
|
323
389
|
Update an existing table.
|
|
324
|
-
|
|
390
|
+
|
|
325
391
|
The table configuration can be provided via:
|
|
326
392
|
- --file: Path to a JSON/YAML file
|
|
327
393
|
- stdin: Pipe JSON/YAML content
|
|
@@ -359,7 +425,7 @@ def table_insert(
|
|
|
359
425
|
):
|
|
360
426
|
"""
|
|
361
427
|
Insert data into a table from a file.
|
|
362
|
-
|
|
428
|
+
|
|
363
429
|
Data is read in chunks and uploaded progressively with a progress bar.
|
|
364
430
|
"""
|
|
365
431
|
config = _read_config()
|
|
@@ -383,7 +449,7 @@ def table_insert(
|
|
|
383
449
|
# Chunk read and upload.
|
|
384
450
|
for chunk in _read_chunks(file, type, chunk_size=1000):
|
|
385
451
|
_write_chunk(chunk)
|
|
386
|
-
|
|
452
|
+
|
|
387
453
|
bar.close()
|
|
388
454
|
|
|
389
455
|
|
|
@@ -440,7 +506,7 @@ def create_view(
|
|
|
440
506
|
):
|
|
441
507
|
"""
|
|
442
508
|
Create a new view.
|
|
443
|
-
|
|
509
|
+
|
|
444
510
|
The view configuration can be provided via:
|
|
445
511
|
- --file: Path to a JSON/YAML file
|
|
446
512
|
- stdin: Pipe JSON/YAML content
|
|
@@ -513,7 +579,7 @@ def update_view(
|
|
|
513
579
|
):
|
|
514
580
|
"""
|
|
515
581
|
Update an existing view.
|
|
516
|
-
|
|
582
|
+
|
|
517
583
|
The view configuration can be provided via:
|
|
518
584
|
- --file: Path to a JSON/YAML file
|
|
519
585
|
- stdin: Pipe JSON/YAML content
|
|
@@ -566,20 +632,22 @@ def delete_view(
|
|
|
566
632
|
|
|
567
633
|
@app.command()
|
|
568
634
|
def query(
|
|
569
|
-
engine_name: str = typer.Option(
|
|
635
|
+
engine_name: str = typer.Option(
|
|
636
|
+
..., help="Name of the engine to execute the query against."
|
|
637
|
+
),
|
|
570
638
|
query_file: typer.FileText = typer.Option(
|
|
571
639
|
None, help="Path to a JSON or YAML file containing the query."
|
|
572
640
|
),
|
|
573
641
|
query: str = typer.Option(
|
|
574
|
-
None, help="
|
|
642
|
+
None, help="Query string (SQL or JSON). Can be used instead of --query-file."
|
|
575
643
|
),
|
|
576
644
|
):
|
|
577
645
|
"""
|
|
578
646
|
Execute an ad-hoc query against an engine.
|
|
579
|
-
|
|
647
|
+
|
|
580
648
|
The query can be provided via:
|
|
581
649
|
- --query-file: Path to a JSON/YAML file
|
|
582
|
-
- --query: JSON string
|
|
650
|
+
- --query: SQL query string or JSON string containing the query
|
|
583
651
|
- stdin: Pipe JSON/YAML content
|
|
584
652
|
"""
|
|
585
653
|
config = _read_config()
|
|
@@ -590,28 +658,79 @@ def query(
|
|
|
590
658
|
"x-api-key": config.api_key,
|
|
591
659
|
}
|
|
592
660
|
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
661
|
+
try:
|
|
662
|
+
# Check stdin only if no other input options are provided.
|
|
663
|
+
# If stdin is not a TTY, peek to see if there's content.
|
|
664
|
+
stdin_has_content = False
|
|
665
|
+
stdin_content = ""
|
|
666
|
+
if not sys.stdin.isatty() and query_file is None and query is None:
|
|
667
|
+
# Only read from stdin if no other options provided.
|
|
668
|
+
stdin_content = sys.stdin.read()
|
|
669
|
+
stdin_has_content = bool(stdin_content.strip())
|
|
670
|
+
if not stdin_has_content:
|
|
671
|
+
raise ValueError(
|
|
672
|
+
"No input provided via stdin. Provide a SQL query string or "
|
|
673
|
+
"JSON query configuration."
|
|
674
|
+
)
|
|
675
|
+
|
|
676
|
+
if stdin_has_content:
|
|
677
|
+
# Read from stdin and normalize to QueryRequest.
|
|
678
|
+
payload = _normalize_query_to_request(stdin_content)
|
|
679
|
+
elif query_file is not None:
|
|
680
|
+
# Read file content and normalize to QueryRequest.
|
|
681
|
+
# Files can contain SQL strings or JSON/YAML.
|
|
682
|
+
try:
|
|
683
|
+
# Try to parse as JSON/YAML first.
|
|
684
|
+
query_file.seek(0)
|
|
685
|
+
file_content = _parse_file_as_json(query_file)
|
|
686
|
+
except (ValueError, json.JSONDecodeError, yaml.YAMLError) as e:
|
|
687
|
+
# If parsing fails, read as raw content (e.g., SQL string).
|
|
688
|
+
query_file.seek(0)
|
|
689
|
+
file_content = query_file.read()
|
|
690
|
+
if not file_content.strip():
|
|
691
|
+
raise ValueError(
|
|
692
|
+
f"File '{query_file.name}' is empty or could not be parsed. "
|
|
693
|
+
"Provide a SQL query string or valid JSON/YAML configuration."
|
|
694
|
+
) from e
|
|
695
|
+
payload = _normalize_query_to_request(file_content)
|
|
696
|
+
elif query is not None:
|
|
697
|
+
# Normalize CLI string input to QueryRequest.
|
|
698
|
+
payload = _normalize_query_to_request(query)
|
|
699
|
+
else:
|
|
700
|
+
raise ValueError(
|
|
701
|
+
"Must provide query input via one of:\n"
|
|
702
|
+
" - --query-file: Path to a file containing SQL or JSON/YAML\n"
|
|
703
|
+
" - --query: SQL query string or JSON string\n"
|
|
704
|
+
" - stdin: Pipe SQL or JSON/YAML content"
|
|
705
|
+
)
|
|
706
|
+
except ValueError as e:
|
|
707
|
+
typer.echo(f"Error: {e}", err=True)
|
|
708
|
+
raise typer.Exit(1)
|
|
709
|
+
except Exception as e:
|
|
710
|
+
typer.echo(f"Error: Unexpected error processing query input: {e}", err=True)
|
|
711
|
+
raise typer.Exit(1)
|
|
603
712
|
|
|
604
713
|
typer.echo(payload)
|
|
605
714
|
response = requests.post(url, headers=headers, data=payload)
|
|
606
715
|
if response.status_code != 200:
|
|
607
|
-
|
|
716
|
+
# Try to parse error response for better error message.
|
|
717
|
+
try:
|
|
718
|
+
error_data = response.json()
|
|
719
|
+
error_msg = error_data.get(
|
|
720
|
+
"message", error_data.get("detail", response.text)
|
|
721
|
+
)
|
|
722
|
+
typer.echo(f"Error {response.status_code}: {error_msg}", err=True)
|
|
723
|
+
except (json.JSONDecodeError, ValueError):
|
|
724
|
+
typer.echo(f"Error {response.status_code}: {response.text}", err=True)
|
|
608
725
|
raise typer.Exit(1)
|
|
609
726
|
typer.echo(_parse_response_as_yaml(response.text))
|
|
610
727
|
|
|
611
728
|
|
|
612
729
|
@app.command()
|
|
613
730
|
def execute_saved_query(
|
|
614
|
-
engine_name: str = typer.Option(
|
|
731
|
+
engine_name: str = typer.Option(
|
|
732
|
+
..., help="Name of the engine containing the saved query."
|
|
733
|
+
),
|
|
615
734
|
query_name: str = typer.Option(..., help="Name of the saved query to execute."),
|
|
616
735
|
):
|
|
617
736
|
"""
|
|
@@ -633,7 +752,9 @@ def execute_saved_query(
|
|
|
633
752
|
|
|
634
753
|
@app.command()
|
|
635
754
|
def view_saved_query(
|
|
636
|
-
engine_name: str = typer.Option(
|
|
755
|
+
engine_name: str = typer.Option(
|
|
756
|
+
..., help="Name of the engine containing the saved query."
|
|
757
|
+
),
|
|
637
758
|
query_name: str = typer.Option(..., help="Name of the saved query to view."),
|
|
638
759
|
):
|
|
639
760
|
"""
|
|
@@ -651,7 +772,9 @@ def view_saved_query(
|
|
|
651
772
|
|
|
652
773
|
@app.command()
|
|
653
774
|
def list_saved_queries(
|
|
654
|
-
engine_name: str = typer.Option(
|
|
775
|
+
engine_name: str = typer.Option(
|
|
776
|
+
..., help="Name of the engine to list saved queries for."
|
|
777
|
+
),
|
|
655
778
|
):
|
|
656
779
|
"""
|
|
657
780
|
List all saved queries for an engine.
|