shaped 2.0.1__py3-none-any.whl → 2.0.2__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 +54 -4
- shaped/autogen/__init__.py +541 -66
- shaped/autogen/api/__init__.py +4 -3
- shaped/autogen/api/engine_api.py +1467 -0
- shaped/autogen/api/{dataset_api.py → query_api.py} +219 -194
- shaped/autogen/api/table_api.py +1494 -0
- shaped/autogen/api/{model_management_api.py → view_api.py} +179 -181
- shaped/autogen/api_client.py +15 -8
- shaped/autogen/configuration.py +20 -9
- shaped/autogen/exceptions.py +19 -2
- shaped/autogen/models/__init__.py +254 -52
- shaped/autogen/models/ai_enrichment_view_config.py +123 -0
- shaped/autogen/models/{path.py → algorithm.py} +19 -19
- shaped/autogen/models/amplitude_table_config.py +106 -0
- shaped/autogen/models/ascending.py +136 -0
- shaped/autogen/models/attn_dropout_prob.py +136 -0
- shaped/autogen/models/attribute_journey.py +124 -0
- shaped/autogen/models/attribute_value.py +178 -0
- shaped/autogen/models/autoscaling_config.py +95 -0
- shaped/autogen/models/aws_pinpoint_table_config.py +108 -0
- shaped/autogen/models/batch_size.py +136 -0
- shaped/autogen/models/batch_size1.py +136 -0
- shaped/autogen/models/batch_size2.py +136 -0
- shaped/autogen/models/big_query_table_config.py +147 -0
- shaped/autogen/models/bm25.py +136 -0
- shaped/autogen/models/boosted_reorder_step.py +125 -0
- shaped/autogen/models/canary_rollout.py +99 -0
- shaped/autogen/models/candidate_attributes_retrieve_step.py +126 -0
- shaped/autogen/models/candidate_ids_retrieve_step.py +113 -0
- shaped/autogen/models/candidate_retrieval_strategy.py +41 -0
- shaped/autogen/models/clickhouse_table_config.py +146 -0
- shaped/autogen/models/column_order_retrieve_step.py +123 -0
- shaped/autogen/models/column_ordering.py +91 -0
- shaped/autogen/models/create_table_response.py +87 -0
- shaped/autogen/models/create_view_response.py +87 -0
- shaped/autogen/models/custom_table_config.py +135 -0
- shaped/autogen/models/data_compute_config.py +89 -0
- shaped/autogen/models/data_config.py +145 -0
- shaped/autogen/models/data_config_interaction_table.py +146 -0
- shaped/autogen/models/data_split_config.py +88 -0
- shaped/autogen/models/data_split_strategy.py +37 -0
- shaped/autogen/models/data_tier.py +37 -0
- shaped/autogen/models/default.py +246 -0
- shaped/autogen/models/delete_engine_response.py +87 -0
- shaped/autogen/models/delete_table_response.py +87 -0
- shaped/autogen/models/delete_view_response.py +87 -0
- shaped/autogen/models/deployment_config.py +123 -0
- shaped/autogen/models/distance_function.py +38 -0
- shaped/autogen/models/diversity_reorder_step.py +137 -0
- shaped/autogen/models/dropout_rate.py +136 -0
- shaped/autogen/models/dynamo_db_table_config.py +160 -0
- shaped/autogen/models/dynamo_db_table_config_scan_kwargs_value.py +138 -0
- shaped/autogen/models/embedder_batch_size.py +136 -0
- shaped/autogen/models/embedding_config.py +93 -0
- shaped/autogen/models/embedding_dim.py +136 -0
- shaped/autogen/models/embedding_dims.py +136 -0
- shaped/autogen/models/embedding_size.py +136 -0
- shaped/autogen/models/encoder.py +140 -0
- shaped/autogen/models/encoding_pooling_strategy.py +38 -0
- shaped/autogen/models/engine.py +109 -0
- shaped/autogen/models/engine_config_v2.py +152 -0
- shaped/autogen/models/engine_details_response.py +120 -0
- shaped/autogen/models/engine_schema.py +113 -0
- shaped/autogen/models/engine_schema_user_inner.py +134 -0
- shaped/autogen/models/entity_config.py +109 -0
- shaped/autogen/models/entity_journey.py +152 -0
- shaped/autogen/models/entity_type.py +38 -0
- shaped/autogen/models/evaluation_config.py +92 -0
- shaped/autogen/models/exploration_reorder_step.py +125 -0
- shaped/autogen/models/expression_filter_step.py +106 -0
- shaped/autogen/models/factors.py +136 -0
- shaped/autogen/models/factors1.py +136 -0
- shaped/autogen/models/feature.py +90 -0
- shaped/autogen/models/feature_type.py +60 -0
- shaped/autogen/models/file_table_config.py +112 -0
- shaped/autogen/models/filter_config.py +99 -0
- shaped/autogen/models/filter_dataset.py +140 -0
- shaped/autogen/models/filter_index_type.py +36 -0
- shaped/autogen/models/filter_retrieve_step.py +113 -0
- shaped/autogen/models/global_filter.py +102 -0
- shaped/autogen/models/hidden_dropout_prob.py +136 -0
- shaped/autogen/models/hidden_size.py +136 -0
- shaped/autogen/models/hidden_size1.py +136 -0
- shaped/autogen/models/http_problem_response.py +115 -0
- shaped/autogen/models/http_validation_error.py +2 -2
- shaped/autogen/models/hugging_face_encoder.py +113 -0
- shaped/autogen/models/iceberg_table_config.py +154 -0
- shaped/autogen/models/index_config.py +101 -0
- shaped/autogen/models/inner_size.py +136 -0
- shaped/autogen/models/inner_size1.py +136 -0
- shaped/autogen/models/interaction_config.py +122 -0
- shaped/autogen/models/interaction_pooling_encoder.py +104 -0
- shaped/autogen/models/interaction_round_robin_encoder.py +104 -0
- shaped/autogen/models/item_attribute_pooling_encoder.py +124 -0
- shaped/autogen/models/journey.py +140 -0
- shaped/autogen/models/kafka_table_config.py +129 -0
- shaped/autogen/models/kinesis_table_config.py +140 -0
- shaped/autogen/models/kinesis_table_config_column_schema_value.py +136 -0
- shaped/autogen/models/label.py +90 -0
- shaped/autogen/models/label_type.py +37 -0
- shaped/autogen/models/laplace_smoothing.py +136 -0
- shaped/autogen/models/latency_scaling_policy.py +112 -0
- shaped/autogen/models/learning_rate.py +136 -0
- shaped/autogen/models/learning_rate1.py +136 -0
- shaped/autogen/models/learning_rate2.py +136 -0
- shaped/autogen/models/learning_rate3.py +136 -0
- shaped/autogen/models/lexical_search_mode.py +99 -0
- shaped/autogen/models/list_engines_response.py +95 -0
- shaped/autogen/models/list_tables_response.py +95 -0
- shaped/autogen/models/list_views_response.py +95 -0
- shaped/autogen/models/loss_types.py +37 -0
- shaped/autogen/models/lr.py +136 -0
- shaped/autogen/models/lr1.py +136 -0
- shaped/autogen/models/lr2.py +136 -0
- shaped/autogen/models/max_depth.py +136 -0
- shaped/autogen/models/max_leaves.py +136 -0
- shaped/autogen/models/max_seq_length.py +136 -0
- shaped/autogen/models/max_seq_length1.py +136 -0
- shaped/autogen/models/max_seq_length2.py +136 -0
- shaped/autogen/models/mode.py +134 -0
- shaped/autogen/models/mode1.py +134 -0
- shaped/autogen/models/mode2.py +136 -0
- shaped/autogen/models/mongo_db_table_config.py +147 -0
- shaped/autogen/models/mssql_table_config.py +155 -0
- shaped/autogen/models/{my_sql_dataset_config.py → my_sql_table_config.py} +45 -28
- shaped/autogen/models/n_epochs.py +136 -0
- shaped/autogen/models/n_epochs1.py +136 -0
- shaped/autogen/models/n_epochs2.py +136 -0
- shaped/autogen/models/n_estimators.py +136 -0
- shaped/autogen/models/n_heads.py +136 -0
- shaped/autogen/models/n_layers.py +136 -0
- shaped/autogen/models/neg_per_positive.py +136 -0
- shaped/autogen/models/negative_samples_count.py +136 -0
- shaped/autogen/models/ngram_tokenizer.py +103 -0
- shaped/autogen/models/no_op_config.py +117 -0
- shaped/autogen/models/num_blocks.py +136 -0
- shaped/autogen/models/num_heads.py +136 -0
- shaped/autogen/models/num_leaves.py +136 -0
- shaped/autogen/models/objective.py +40 -0
- shaped/autogen/models/objective1.py +134 -0
- shaped/autogen/models/online_store_config.py +89 -0
- shaped/autogen/models/pagination_config.py +87 -0
- shaped/autogen/models/parameter_definition.py +96 -0
- shaped/autogen/models/parameters_value.py +240 -0
- shaped/autogen/models/passthrough_score.py +104 -0
- shaped/autogen/models/personal_filter.py +104 -0
- shaped/autogen/models/pipeline_stage_explanation.py +118 -0
- shaped/autogen/models/policy.py +134 -0
- shaped/autogen/models/pool_fn.py +134 -0
- shaped/autogen/models/pooling_function.py +37 -0
- shaped/autogen/models/{postgres_dataset_config.py → postgres_table_config.py} +66 -28
- shaped/autogen/models/posthog_table_config.py +133 -0
- shaped/autogen/models/prebuilt_filter_step.py +113 -0
- shaped/autogen/models/precomputed_item_embedding.py +99 -0
- shaped/autogen/models/precomputed_user_embedding.py +99 -0
- shaped/autogen/models/query.py +136 -0
- shaped/autogen/models/query1.py +136 -0
- shaped/autogen/models/query_any_of.py +140 -0
- shaped/autogen/models/query_definition.py +106 -0
- shaped/autogen/models/query_encoder.py +194 -0
- shaped/autogen/models/query_explanation.py +197 -0
- shaped/autogen/models/query_request.py +121 -0
- shaped/autogen/models/query_result.py +113 -0
- shaped/autogen/models/query_table_config.py +99 -0
- shaped/autogen/models/rank_item_attribute_values_query_config.py +122 -0
- shaped/autogen/models/rank_query_config.py +167 -0
- shaped/autogen/models/rank_query_config_filter_inner.py +149 -0
- shaped/autogen/models/rank_query_config_reorder_inner.py +149 -0
- shaped/autogen/models/rank_query_config_retrieve_inner.py +196 -0
- shaped/autogen/models/recreate_rollout.py +97 -0
- shaped/autogen/models/{redshift_dataset_config.py → redshift_table_config.py} +48 -25
- shaped/autogen/models/reference_table_config.py +113 -0
- shaped/autogen/models/regularization.py +136 -0
- shaped/autogen/models/request.py +378 -0
- shaped/autogen/models/request1.py +140 -0
- shaped/autogen/models/requests_per_second_scaling_policy.py +112 -0
- shaped/autogen/models/response_get_view_details_views_view_name_get.py +134 -0
- shaped/autogen/models/result.py +145 -0
- shaped/autogen/models/result_embeddings_value.py +127 -0
- shaped/autogen/models/retriever.py +196 -0
- shaped/autogen/models/retriever1.py +196 -0
- shaped/autogen/models/rollout_config.py +91 -0
- shaped/autogen/models/rudderstack_table_config.py +106 -0
- shaped/autogen/models/sampling_strategy.py +36 -0
- shaped/autogen/models/saved_query_info_response.py +89 -0
- shaped/autogen/models/saved_query_list_response.py +87 -0
- shaped/autogen/models/saved_query_request.py +115 -0
- shaped/autogen/models/schema_config.py +117 -0
- shaped/autogen/models/score.py +134 -0
- shaped/autogen/models/score_ensemble.py +140 -0
- shaped/autogen/models/score_ensemble_policy_config.py +141 -0
- shaped/autogen/models/score_ensemble_policy_config_policies_inner.py +422 -0
- shaped/autogen/models/search_config.py +105 -0
- shaped/autogen/models/segment_table_config.py +106 -0
- shaped/autogen/models/sequence_length.py +136 -0
- shaped/autogen/models/server_config.py +87 -0
- shaped/autogen/models/setup_engine_response.py +87 -0
- shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py +148 -0
- shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py +154 -0
- shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py +209 -0
- shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py +137 -0
- shaped/autogen/models/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py +139 -0
- shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py +205 -0
- shaped/autogen/models/shaped_internal_recsys_policies_item2vec_model_policy_item2_vec_model_policy_config.py +140 -0
- shaped/autogen/models/shaped_internal_recsys_policies_item_content_similarity_model_policy_item_content_similarity_model_policy_config.py +152 -0
- shaped/autogen/models/shaped_internal_recsys_policies_lightgbm_model_policy_lightgbm_model_policy_light_gbm_model_policy_config.py +239 -0
- shaped/autogen/models/shaped_internal_recsys_policies_ngram_model_policy_ngram_model_policy_config.py +119 -0
- shaped/autogen/models/shaped_internal_recsys_policies_popular_model_policy_popular_model_policy_config.py +137 -0
- shaped/autogen/models/shaped_internal_recsys_policies_random_model_policy_random_model_policy_config.py +104 -0
- shaped/autogen/models/shaped_internal_recsys_policies_recently_popular_policy_recently_popular_policy_config.py +130 -0
- shaped/autogen/models/shaped_internal_recsys_policies_rising_popular_policy_rising_popular_policy_config.py +123 -0
- shaped/autogen/models/shaped_internal_recsys_policies_sasrec_model_policy_sasrec_model_policy_sas_rec_model_policy_config.py +224 -0
- shaped/autogen/models/shaped_internal_recsys_policies_svd_model_policy_svd_model_policy_config.py +119 -0
- shaped/autogen/models/shaped_internal_recsys_policies_two_tower_model_policy_two_tower_model_policy_two_tower_model_policy_config.py +159 -0
- shaped/autogen/models/shaped_internal_recsys_policies_user_item_content_similarity_model_policy_user_item_content_similarity_model_policy_config.py +131 -0
- shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py +131 -0
- shaped/autogen/models/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py +149 -0
- shaped/autogen/models/shopify_table_config.py +156 -0
- shaped/autogen/models/similarity_retrieve_step.py +121 -0
- shaped/autogen/models/{snowflake_dataset_config.py → snowflake_table_config.py} +47 -18
- shaped/autogen/models/sql_transform_type.py +37 -0
- shaped/autogen/models/sql_view_config.py +111 -0
- shaped/autogen/models/stemmer_tokenizer.py +105 -0
- shaped/autogen/models/step_explanation.py +137 -0
- shaped/autogen/models/strategy.py +134 -0
- shaped/autogen/models/table.py +102 -0
- shaped/autogen/models/table_deployment_type.py +38 -0
- shaped/autogen/models/table_insert_arguments.py +87 -0
- shaped/autogen/models/table_insert_response.py +87 -0
- shaped/autogen/models/text_encoding.py +136 -0
- shaped/autogen/models/text_search_retrieve_step.py +121 -0
- shaped/autogen/models/time_frequency.py +136 -0
- shaped/autogen/models/time_window.py +136 -0
- shaped/autogen/models/time_window_in_days.py +142 -0
- shaped/autogen/models/tokenizer.py +149 -0
- shaped/autogen/models/trained_model_encoder.py +99 -0
- shaped/autogen/models/training_compute_config.py +99 -0
- shaped/autogen/models/training_config.py +121 -0
- shaped/autogen/models/training_config_models_inner.py +308 -0
- shaped/autogen/models/training_strategy.py +37 -0
- shaped/autogen/models/trending_mode.py +37 -0
- shaped/autogen/models/truncate_filter_step.py +106 -0
- shaped/autogen/models/tunable_bool.py +97 -0
- shaped/autogen/models/tunable_float.py +118 -0
- shaped/autogen/models/tunable_int.py +118 -0
- shaped/autogen/models/tunable_int_categorical.py +99 -0
- shaped/autogen/models/tunable_string.py +99 -0
- shaped/autogen/models/tuning_config.py +89 -0
- shaped/autogen/models/type.py +134 -0
- shaped/autogen/models/update_table_response.py +87 -0
- shaped/autogen/models/update_view_response.py +87 -0
- shaped/autogen/models/user_attribute_pooling_encoder.py +124 -0
- shaped/autogen/models/val_split.py +136 -0
- shaped/autogen/models/validation_error.py +13 -3
- shaped/autogen/models/validation_error_loc_inner.py +138 -0
- shaped/autogen/models/value_type.py +7 -5
- shaped/autogen/models/vector_search_mode.py +99 -0
- shaped/autogen/models/view.py +104 -0
- shaped/autogen/models/view_details_ai.py +140 -0
- shaped/autogen/models/view_details_ai_schema_value.py +153 -0
- shaped/autogen/models/view_details_sql.py +140 -0
- shaped/autogen/models/view_status.py +41 -0
- shaped/autogen/models/weight_decay.py +136 -0
- shaped/autogen/models/whitespace_tokenizer.py +97 -0
- shaped/autogen/models/window_size.py +136 -0
- shaped/autogen/rest.py +8 -2
- shaped/cli/shaped_cli.py +12 -7
- shaped/client.py +587 -174
- shaped/config_builders.py +695 -0
- shaped/query_builder.py +774 -0
- {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/METADATA +140 -5
- shaped-2.0.2.dist-info/RECORD +278 -0
- shaped-2.0.2.dist-info/entry_points.txt +2 -0
- shaped/autogen/api/model_inference_api.py +0 -2825
- shaped/autogen/models/amplitude_dataset_config.py +0 -96
- shaped/autogen/models/aws_pinpoint_dataset_config.py +0 -96
- shaped/autogen/models/big_query_dataset_config.py +0 -114
- shaped/autogen/models/complement_items_request.py +0 -99
- shaped/autogen/models/complement_items_response.py +0 -89
- shaped/autogen/models/connectors_inner.py +0 -134
- shaped/autogen/models/create_dataset_arguments.py +0 -263
- shaped/autogen/models/create_embedding_response.py +0 -87
- shaped/autogen/models/create_item_embedding_request.py +0 -89
- shaped/autogen/models/create_model_arguments.py +0 -107
- shaped/autogen/models/create_model_response.py +0 -87
- shaped/autogen/models/create_user_embedding_request.py +0 -89
- shaped/autogen/models/custom_dataset_config.py +0 -115
- shaped/autogen/models/dataset_config.py +0 -101
- shaped/autogen/models/dataset_schema_type.py +0 -47
- shaped/autogen/models/datasets_inner.py +0 -91
- shaped/autogen/models/delete_model_response.py +0 -87
- shaped/autogen/models/fetch_config.py +0 -95
- shaped/autogen/models/file_config.py +0 -105
- shaped/autogen/models/file_source_config.py +0 -89
- shaped/autogen/models/inference_config.py +0 -101
- shaped/autogen/models/insert_model_response.py +0 -87
- shaped/autogen/models/interaction.py +0 -87
- shaped/autogen/models/list_datasets_response.py +0 -95
- shaped/autogen/models/list_models_response.py +0 -95
- shaped/autogen/models/model_config.py +0 -99
- shaped/autogen/models/model_response.py +0 -95
- shaped/autogen/models/mongo_db_dataset_config.py +0 -119
- shaped/autogen/models/post_rank_request.py +0 -117
- shaped/autogen/models/rank_attribute_response.py +0 -89
- shaped/autogen/models/rank_grid_attribute_request.py +0 -91
- shaped/autogen/models/rank_grid_attribute_request1.py +0 -93
- shaped/autogen/models/rank_grid_attribute_response.py +0 -91
- shaped/autogen/models/rank_response.py +0 -91
- shaped/autogen/models/retrieve_request.py +0 -101
- shaped/autogen/models/retrieve_response.py +0 -91
- shaped/autogen/models/retriever_top_k_override.py +0 -97
- shaped/autogen/models/rudder_stack_dataset_config.py +0 -96
- shaped/autogen/models/segment_dataset_config.py +0 -96
- shaped/autogen/models/similar_item_request.py +0 -101
- shaped/autogen/models/similar_response.py +0 -89
- shaped/autogen/models/similar_users_request.py +0 -99
- shaped/autogen/models/successful_response.py +0 -87
- shaped/autogen/models/view_model_response.py +0 -99
- shaped-2.0.1.dist-info/RECORD +0 -73
- shaped-2.0.1.dist-info/entry_points.txt +0 -2
- {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/WHEEL +0 -0
- {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/top_level.txt +0 -0
- {shaped-2.0.1.dist-info → shaped-2.0.2.dist-info}/zip-safe +0 -0
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"""
|
|
4
4
|
Shaped API
|
|
5
5
|
|
|
6
|
-
Welcome to Shaped's API reference docs. These provide a
|
|
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:
|
|
8
|
+
The version of the OpenAPI document: 2.0.0
|
|
9
9
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
10
|
|
|
11
11
|
Do not edit the class manually.
|
|
@@ -16,19 +16,19 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
|
16
16
|
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
17
17
|
from typing_extensions import Annotated
|
|
18
18
|
|
|
19
|
-
from pydantic import
|
|
20
|
-
from
|
|
21
|
-
from shaped.autogen.models.
|
|
22
|
-
from shaped.autogen.models.
|
|
23
|
-
from shaped.autogen.models.
|
|
24
|
-
from shaped.autogen.models.
|
|
19
|
+
from pydantic import StrictStr
|
|
20
|
+
from shaped.autogen.models.query_request import QueryRequest
|
|
21
|
+
from shaped.autogen.models.query_result import QueryResult
|
|
22
|
+
from shaped.autogen.models.saved_query_info_response import SavedQueryInfoResponse
|
|
23
|
+
from shaped.autogen.models.saved_query_list_response import SavedQueryListResponse
|
|
24
|
+
from shaped.autogen.models.saved_query_request import SavedQueryRequest
|
|
25
25
|
|
|
26
26
|
from shaped.autogen.api_client import ApiClient, RequestSerialized
|
|
27
27
|
from shaped.autogen.api_response import ApiResponse
|
|
28
28
|
from shaped.autogen.rest import RESTResponseType
|
|
29
29
|
|
|
30
30
|
|
|
31
|
-
class
|
|
31
|
+
class QueryApi:
|
|
32
32
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
33
33
|
Ref: https://openapi-generator.tech
|
|
34
34
|
|
|
@@ -42,10 +42,10 @@ class DatasetApi:
|
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
@validate_call
|
|
45
|
-
def
|
|
45
|
+
def execute_ad_hoc_query_query_post(
|
|
46
46
|
self,
|
|
47
|
-
|
|
48
|
-
|
|
47
|
+
engine_name: StrictStr,
|
|
48
|
+
query_request: QueryRequest,
|
|
49
49
|
_request_timeout: Union[
|
|
50
50
|
None,
|
|
51
51
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -58,15 +58,15 @@ class DatasetApi:
|
|
|
58
58
|
_content_type: Optional[StrictStr] = None,
|
|
59
59
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
60
60
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
61
|
-
) ->
|
|
62
|
-
"""
|
|
61
|
+
) -> QueryResult:
|
|
62
|
+
"""Execute Query
|
|
63
63
|
|
|
64
|
-
|
|
64
|
+
Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
|
|
65
65
|
|
|
66
|
-
:param
|
|
67
|
-
:type
|
|
68
|
-
:param
|
|
69
|
-
:type
|
|
66
|
+
:param engine_name: (required)
|
|
67
|
+
:type engine_name: str
|
|
68
|
+
:param query_request: (required)
|
|
69
|
+
:type query_request: QueryRequest
|
|
70
70
|
:param _request_timeout: timeout setting for this request. If one
|
|
71
71
|
number provided, it will be total request
|
|
72
72
|
timeout. It can also be a pair (tuple) of
|
|
@@ -89,9 +89,9 @@ class DatasetApi:
|
|
|
89
89
|
:return: Returns the result object.
|
|
90
90
|
""" # noqa: E501
|
|
91
91
|
|
|
92
|
-
_param = self.
|
|
93
|
-
|
|
94
|
-
|
|
92
|
+
_param = self._execute_ad_hoc_query_query_post_serialize(
|
|
93
|
+
engine_name=engine_name,
|
|
94
|
+
query_request=query_request,
|
|
95
95
|
_request_auth=_request_auth,
|
|
96
96
|
_content_type=_content_type,
|
|
97
97
|
_headers=_headers,
|
|
@@ -99,7 +99,7 @@ class DatasetApi:
|
|
|
99
99
|
)
|
|
100
100
|
|
|
101
101
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
102
|
-
'200': "
|
|
102
|
+
'200': "QueryResult",
|
|
103
103
|
'422': "HTTPValidationError",
|
|
104
104
|
}
|
|
105
105
|
response_data = self.api_client.call_api(
|
|
@@ -114,10 +114,10 @@ class DatasetApi:
|
|
|
114
114
|
|
|
115
115
|
|
|
116
116
|
@validate_call
|
|
117
|
-
def
|
|
117
|
+
def execute_ad_hoc_query_query_post_with_http_info(
|
|
118
118
|
self,
|
|
119
|
-
|
|
120
|
-
|
|
119
|
+
engine_name: StrictStr,
|
|
120
|
+
query_request: QueryRequest,
|
|
121
121
|
_request_timeout: Union[
|
|
122
122
|
None,
|
|
123
123
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -130,15 +130,15 @@ class DatasetApi:
|
|
|
130
130
|
_content_type: Optional[StrictStr] = None,
|
|
131
131
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
132
132
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
133
|
-
) -> ApiResponse[
|
|
134
|
-
"""
|
|
133
|
+
) -> ApiResponse[QueryResult]:
|
|
134
|
+
"""Execute Query
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
|
|
137
137
|
|
|
138
|
-
:param
|
|
139
|
-
:type
|
|
140
|
-
:param
|
|
141
|
-
:type
|
|
138
|
+
:param engine_name: (required)
|
|
139
|
+
:type engine_name: str
|
|
140
|
+
:param query_request: (required)
|
|
141
|
+
:type query_request: QueryRequest
|
|
142
142
|
:param _request_timeout: timeout setting for this request. If one
|
|
143
143
|
number provided, it will be total request
|
|
144
144
|
timeout. It can also be a pair (tuple) of
|
|
@@ -161,9 +161,9 @@ class DatasetApi:
|
|
|
161
161
|
:return: Returns the result object.
|
|
162
162
|
""" # noqa: E501
|
|
163
163
|
|
|
164
|
-
_param = self.
|
|
165
|
-
|
|
166
|
-
|
|
164
|
+
_param = self._execute_ad_hoc_query_query_post_serialize(
|
|
165
|
+
engine_name=engine_name,
|
|
166
|
+
query_request=query_request,
|
|
167
167
|
_request_auth=_request_auth,
|
|
168
168
|
_content_type=_content_type,
|
|
169
169
|
_headers=_headers,
|
|
@@ -171,7 +171,7 @@ class DatasetApi:
|
|
|
171
171
|
)
|
|
172
172
|
|
|
173
173
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
174
|
-
'200': "
|
|
174
|
+
'200': "QueryResult",
|
|
175
175
|
'422': "HTTPValidationError",
|
|
176
176
|
}
|
|
177
177
|
response_data = self.api_client.call_api(
|
|
@@ -186,10 +186,10 @@ class DatasetApi:
|
|
|
186
186
|
|
|
187
187
|
|
|
188
188
|
@validate_call
|
|
189
|
-
def
|
|
189
|
+
def execute_ad_hoc_query_query_post_without_preload_content(
|
|
190
190
|
self,
|
|
191
|
-
|
|
192
|
-
|
|
191
|
+
engine_name: StrictStr,
|
|
192
|
+
query_request: QueryRequest,
|
|
193
193
|
_request_timeout: Union[
|
|
194
194
|
None,
|
|
195
195
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -203,14 +203,14 @@ class DatasetApi:
|
|
|
203
203
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
204
204
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
205
205
|
) -> RESTResponseType:
|
|
206
|
-
"""
|
|
206
|
+
"""Execute Query
|
|
207
207
|
|
|
208
|
-
|
|
208
|
+
Execute a query with the provided QueryConfig. Use this endpoint to execute on-demand queries for development or experimentation.
|
|
209
209
|
|
|
210
|
-
:param
|
|
211
|
-
:type
|
|
212
|
-
:param
|
|
213
|
-
:type
|
|
210
|
+
:param engine_name: (required)
|
|
211
|
+
:type engine_name: str
|
|
212
|
+
:param query_request: (required)
|
|
213
|
+
:type query_request: QueryRequest
|
|
214
214
|
:param _request_timeout: timeout setting for this request. If one
|
|
215
215
|
number provided, it will be total request
|
|
216
216
|
timeout. It can also be a pair (tuple) of
|
|
@@ -233,9 +233,9 @@ class DatasetApi:
|
|
|
233
233
|
:return: Returns the result object.
|
|
234
234
|
""" # noqa: E501
|
|
235
235
|
|
|
236
|
-
_param = self.
|
|
237
|
-
|
|
238
|
-
|
|
236
|
+
_param = self._execute_ad_hoc_query_query_post_serialize(
|
|
237
|
+
engine_name=engine_name,
|
|
238
|
+
query_request=query_request,
|
|
239
239
|
_request_auth=_request_auth,
|
|
240
240
|
_content_type=_content_type,
|
|
241
241
|
_headers=_headers,
|
|
@@ -243,7 +243,7 @@ class DatasetApi:
|
|
|
243
243
|
)
|
|
244
244
|
|
|
245
245
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
246
|
-
'200': "
|
|
246
|
+
'200': "QueryResult",
|
|
247
247
|
'422': "HTTPValidationError",
|
|
248
248
|
}
|
|
249
249
|
response_data = self.api_client.call_api(
|
|
@@ -253,10 +253,10 @@ class DatasetApi:
|
|
|
253
253
|
return response_data.response
|
|
254
254
|
|
|
255
255
|
|
|
256
|
-
def
|
|
256
|
+
def _execute_ad_hoc_query_query_post_serialize(
|
|
257
257
|
self,
|
|
258
|
-
|
|
259
|
-
|
|
258
|
+
engine_name,
|
|
259
|
+
query_request,
|
|
260
260
|
_request_auth,
|
|
261
261
|
_content_type,
|
|
262
262
|
_headers,
|
|
@@ -278,14 +278,14 @@ class DatasetApi:
|
|
|
278
278
|
_body_params: Optional[bytes] = None
|
|
279
279
|
|
|
280
280
|
# process the path parameters
|
|
281
|
+
if engine_name is not None:
|
|
282
|
+
_path_params['engine_name'] = engine_name
|
|
281
283
|
# process the query parameters
|
|
282
284
|
# process the header parameters
|
|
283
|
-
if x_api_key is not None:
|
|
284
|
-
_header_params['x-api-key'] = x_api_key
|
|
285
285
|
# process the form parameters
|
|
286
286
|
# process the body parameter
|
|
287
|
-
if
|
|
288
|
-
_body_params =
|
|
287
|
+
if query_request is not None:
|
|
288
|
+
_body_params = query_request
|
|
289
289
|
|
|
290
290
|
|
|
291
291
|
# set the HTTP header `Accept`
|
|
@@ -316,7 +316,7 @@ class DatasetApi:
|
|
|
316
316
|
|
|
317
317
|
return self.api_client.param_serialize(
|
|
318
318
|
method='POST',
|
|
319
|
-
resource_path='/
|
|
319
|
+
resource_path='/engines/{engine_name}/query',
|
|
320
320
|
path_params=_path_params,
|
|
321
321
|
query_params=_query_params,
|
|
322
322
|
header_params=_header_params,
|
|
@@ -333,10 +333,11 @@ class DatasetApi:
|
|
|
333
333
|
|
|
334
334
|
|
|
335
335
|
@validate_call
|
|
336
|
-
def
|
|
336
|
+
def execute_saved_query_queries_query_name_post(
|
|
337
337
|
self,
|
|
338
|
-
|
|
339
|
-
|
|
338
|
+
engine_name: StrictStr,
|
|
339
|
+
query_name: StrictStr,
|
|
340
|
+
saved_query_request: SavedQueryRequest,
|
|
340
341
|
_request_timeout: Union[
|
|
341
342
|
None,
|
|
342
343
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -349,15 +350,17 @@ class DatasetApi:
|
|
|
349
350
|
_content_type: Optional[StrictStr] = None,
|
|
350
351
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
351
352
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
352
|
-
) ->
|
|
353
|
-
"""
|
|
353
|
+
) -> QueryResult:
|
|
354
|
+
"""Execute Saved Query
|
|
354
355
|
|
|
355
|
-
|
|
356
|
+
Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
|
|
356
357
|
|
|
357
|
-
:param
|
|
358
|
-
:type
|
|
359
|
-
:param
|
|
360
|
-
:type
|
|
358
|
+
:param engine_name: (required)
|
|
359
|
+
:type engine_name: str
|
|
360
|
+
:param query_name: (required)
|
|
361
|
+
:type query_name: str
|
|
362
|
+
:param saved_query_request: (required)
|
|
363
|
+
:type saved_query_request: SavedQueryRequest
|
|
361
364
|
:param _request_timeout: timeout setting for this request. If one
|
|
362
365
|
number provided, it will be total request
|
|
363
366
|
timeout. It can also be a pair (tuple) of
|
|
@@ -380,9 +383,10 @@ class DatasetApi:
|
|
|
380
383
|
:return: Returns the result object.
|
|
381
384
|
""" # noqa: E501
|
|
382
385
|
|
|
383
|
-
_param = self.
|
|
384
|
-
|
|
385
|
-
|
|
386
|
+
_param = self._execute_saved_query_queries_query_name_post_serialize(
|
|
387
|
+
engine_name=engine_name,
|
|
388
|
+
query_name=query_name,
|
|
389
|
+
saved_query_request=saved_query_request,
|
|
386
390
|
_request_auth=_request_auth,
|
|
387
391
|
_content_type=_content_type,
|
|
388
392
|
_headers=_headers,
|
|
@@ -390,7 +394,7 @@ class DatasetApi:
|
|
|
390
394
|
)
|
|
391
395
|
|
|
392
396
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
393
|
-
'200': "
|
|
397
|
+
'200': "QueryResult",
|
|
394
398
|
'422': "HTTPValidationError",
|
|
395
399
|
}
|
|
396
400
|
response_data = self.api_client.call_api(
|
|
@@ -405,10 +409,11 @@ class DatasetApi:
|
|
|
405
409
|
|
|
406
410
|
|
|
407
411
|
@validate_call
|
|
408
|
-
def
|
|
412
|
+
def execute_saved_query_queries_query_name_post_with_http_info(
|
|
409
413
|
self,
|
|
410
|
-
|
|
411
|
-
|
|
414
|
+
engine_name: StrictStr,
|
|
415
|
+
query_name: StrictStr,
|
|
416
|
+
saved_query_request: SavedQueryRequest,
|
|
412
417
|
_request_timeout: Union[
|
|
413
418
|
None,
|
|
414
419
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -421,15 +426,17 @@ class DatasetApi:
|
|
|
421
426
|
_content_type: Optional[StrictStr] = None,
|
|
422
427
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
423
428
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
424
|
-
) -> ApiResponse[
|
|
425
|
-
"""
|
|
429
|
+
) -> ApiResponse[QueryResult]:
|
|
430
|
+
"""Execute Saved Query
|
|
426
431
|
|
|
427
|
-
|
|
432
|
+
Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
|
|
428
433
|
|
|
429
|
-
:param
|
|
430
|
-
:type
|
|
431
|
-
:param
|
|
432
|
-
:type
|
|
434
|
+
:param engine_name: (required)
|
|
435
|
+
:type engine_name: str
|
|
436
|
+
:param query_name: (required)
|
|
437
|
+
:type query_name: str
|
|
438
|
+
:param saved_query_request: (required)
|
|
439
|
+
:type saved_query_request: SavedQueryRequest
|
|
433
440
|
:param _request_timeout: timeout setting for this request. If one
|
|
434
441
|
number provided, it will be total request
|
|
435
442
|
timeout. It can also be a pair (tuple) of
|
|
@@ -452,9 +459,10 @@ class DatasetApi:
|
|
|
452
459
|
:return: Returns the result object.
|
|
453
460
|
""" # noqa: E501
|
|
454
461
|
|
|
455
|
-
_param = self.
|
|
456
|
-
|
|
457
|
-
|
|
462
|
+
_param = self._execute_saved_query_queries_query_name_post_serialize(
|
|
463
|
+
engine_name=engine_name,
|
|
464
|
+
query_name=query_name,
|
|
465
|
+
saved_query_request=saved_query_request,
|
|
458
466
|
_request_auth=_request_auth,
|
|
459
467
|
_content_type=_content_type,
|
|
460
468
|
_headers=_headers,
|
|
@@ -462,7 +470,7 @@ class DatasetApi:
|
|
|
462
470
|
)
|
|
463
471
|
|
|
464
472
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
465
|
-
'200': "
|
|
473
|
+
'200': "QueryResult",
|
|
466
474
|
'422': "HTTPValidationError",
|
|
467
475
|
}
|
|
468
476
|
response_data = self.api_client.call_api(
|
|
@@ -477,10 +485,11 @@ class DatasetApi:
|
|
|
477
485
|
|
|
478
486
|
|
|
479
487
|
@validate_call
|
|
480
|
-
def
|
|
488
|
+
def execute_saved_query_queries_query_name_post_without_preload_content(
|
|
481
489
|
self,
|
|
482
|
-
|
|
483
|
-
|
|
490
|
+
engine_name: StrictStr,
|
|
491
|
+
query_name: StrictStr,
|
|
492
|
+
saved_query_request: SavedQueryRequest,
|
|
484
493
|
_request_timeout: Union[
|
|
485
494
|
None,
|
|
486
495
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -494,14 +503,16 @@ class DatasetApi:
|
|
|
494
503
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
495
504
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
496
505
|
) -> RESTResponseType:
|
|
497
|
-
"""
|
|
506
|
+
"""Execute Saved Query
|
|
498
507
|
|
|
499
|
-
|
|
508
|
+
Execute a saved query by name. The `parameters` field defines inputs for the saved query, such as a search string or user ID.
|
|
500
509
|
|
|
501
|
-
:param
|
|
502
|
-
:type
|
|
503
|
-
:param
|
|
504
|
-
:type
|
|
510
|
+
:param engine_name: (required)
|
|
511
|
+
:type engine_name: str
|
|
512
|
+
:param query_name: (required)
|
|
513
|
+
:type query_name: str
|
|
514
|
+
:param saved_query_request: (required)
|
|
515
|
+
:type saved_query_request: SavedQueryRequest
|
|
505
516
|
:param _request_timeout: timeout setting for this request. If one
|
|
506
517
|
number provided, it will be total request
|
|
507
518
|
timeout. It can also be a pair (tuple) of
|
|
@@ -524,9 +535,10 @@ class DatasetApi:
|
|
|
524
535
|
:return: Returns the result object.
|
|
525
536
|
""" # noqa: E501
|
|
526
537
|
|
|
527
|
-
_param = self.
|
|
528
|
-
|
|
529
|
-
|
|
538
|
+
_param = self._execute_saved_query_queries_query_name_post_serialize(
|
|
539
|
+
engine_name=engine_name,
|
|
540
|
+
query_name=query_name,
|
|
541
|
+
saved_query_request=saved_query_request,
|
|
530
542
|
_request_auth=_request_auth,
|
|
531
543
|
_content_type=_content_type,
|
|
532
544
|
_headers=_headers,
|
|
@@ -534,7 +546,7 @@ class DatasetApi:
|
|
|
534
546
|
)
|
|
535
547
|
|
|
536
548
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
537
|
-
'200': "
|
|
549
|
+
'200': "QueryResult",
|
|
538
550
|
'422': "HTTPValidationError",
|
|
539
551
|
}
|
|
540
552
|
response_data = self.api_client.call_api(
|
|
@@ -544,10 +556,11 @@ class DatasetApi:
|
|
|
544
556
|
return response_data.response
|
|
545
557
|
|
|
546
558
|
|
|
547
|
-
def
|
|
559
|
+
def _execute_saved_query_queries_query_name_post_serialize(
|
|
548
560
|
self,
|
|
549
|
-
|
|
550
|
-
|
|
561
|
+
engine_name,
|
|
562
|
+
query_name,
|
|
563
|
+
saved_query_request,
|
|
551
564
|
_request_auth,
|
|
552
565
|
_content_type,
|
|
553
566
|
_headers,
|
|
@@ -569,14 +582,16 @@ class DatasetApi:
|
|
|
569
582
|
_body_params: Optional[bytes] = None
|
|
570
583
|
|
|
571
584
|
# process the path parameters
|
|
572
|
-
if
|
|
573
|
-
_path_params['
|
|
585
|
+
if engine_name is not None:
|
|
586
|
+
_path_params['engine_name'] = engine_name
|
|
587
|
+
if query_name is not None:
|
|
588
|
+
_path_params['query_name'] = query_name
|
|
574
589
|
# process the query parameters
|
|
575
590
|
# process the header parameters
|
|
576
|
-
if x_api_key is not None:
|
|
577
|
-
_header_params['x-api-key'] = x_api_key
|
|
578
591
|
# process the form parameters
|
|
579
592
|
# process the body parameter
|
|
593
|
+
if saved_query_request is not None:
|
|
594
|
+
_body_params = saved_query_request
|
|
580
595
|
|
|
581
596
|
|
|
582
597
|
# set the HTTP header `Accept`
|
|
@@ -587,6 +602,19 @@ class DatasetApi:
|
|
|
587
602
|
]
|
|
588
603
|
)
|
|
589
604
|
|
|
605
|
+
# set the HTTP header `Content-Type`
|
|
606
|
+
if _content_type:
|
|
607
|
+
_header_params['Content-Type'] = _content_type
|
|
608
|
+
else:
|
|
609
|
+
_default_content_type = (
|
|
610
|
+
self.api_client.select_header_content_type(
|
|
611
|
+
[
|
|
612
|
+
'application/json'
|
|
613
|
+
]
|
|
614
|
+
)
|
|
615
|
+
)
|
|
616
|
+
if _default_content_type is not None:
|
|
617
|
+
_header_params['Content-Type'] = _default_content_type
|
|
590
618
|
|
|
591
619
|
# authentication setting
|
|
592
620
|
_auth_settings: List[str] = [
|
|
@@ -594,7 +622,7 @@ class DatasetApi:
|
|
|
594
622
|
|
|
595
623
|
return self.api_client.param_serialize(
|
|
596
624
|
method='POST',
|
|
597
|
-
resource_path='/
|
|
625
|
+
resource_path='/engines/{engine_name}/queries/{query_name}',
|
|
598
626
|
path_params=_path_params,
|
|
599
627
|
query_params=_query_params,
|
|
600
628
|
header_params=_header_params,
|
|
@@ -611,10 +639,10 @@ class DatasetApi:
|
|
|
611
639
|
|
|
612
640
|
|
|
613
641
|
@validate_call
|
|
614
|
-
def
|
|
642
|
+
def get_saved_query_info_queries_query_name_get(
|
|
615
643
|
self,
|
|
616
|
-
|
|
617
|
-
|
|
644
|
+
engine_name: StrictStr,
|
|
645
|
+
query_name: StrictStr,
|
|
618
646
|
_request_timeout: Union[
|
|
619
647
|
None,
|
|
620
648
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -627,15 +655,15 @@ class DatasetApi:
|
|
|
627
655
|
_content_type: Optional[StrictStr] = None,
|
|
628
656
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
629
657
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
630
|
-
) ->
|
|
631
|
-
"""
|
|
658
|
+
) -> SavedQueryInfoResponse:
|
|
659
|
+
"""Get Saved Query Details
|
|
632
660
|
|
|
633
|
-
|
|
661
|
+
Get information about a specific saved query.
|
|
634
662
|
|
|
635
|
-
:param
|
|
636
|
-
:type
|
|
637
|
-
:param
|
|
638
|
-
:type
|
|
663
|
+
:param engine_name: (required)
|
|
664
|
+
:type engine_name: str
|
|
665
|
+
:param query_name: (required)
|
|
666
|
+
:type query_name: str
|
|
639
667
|
:param _request_timeout: timeout setting for this request. If one
|
|
640
668
|
number provided, it will be total request
|
|
641
669
|
timeout. It can also be a pair (tuple) of
|
|
@@ -658,9 +686,9 @@ class DatasetApi:
|
|
|
658
686
|
:return: Returns the result object.
|
|
659
687
|
""" # noqa: E501
|
|
660
688
|
|
|
661
|
-
_param = self.
|
|
662
|
-
|
|
663
|
-
|
|
689
|
+
_param = self._get_saved_query_info_queries_query_name_get_serialize(
|
|
690
|
+
engine_name=engine_name,
|
|
691
|
+
query_name=query_name,
|
|
664
692
|
_request_auth=_request_auth,
|
|
665
693
|
_content_type=_content_type,
|
|
666
694
|
_headers=_headers,
|
|
@@ -668,7 +696,7 @@ class DatasetApi:
|
|
|
668
696
|
)
|
|
669
697
|
|
|
670
698
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
671
|
-
'200': "
|
|
699
|
+
'200': "SavedQueryInfoResponse",
|
|
672
700
|
'422': "HTTPValidationError",
|
|
673
701
|
}
|
|
674
702
|
response_data = self.api_client.call_api(
|
|
@@ -683,10 +711,10 @@ class DatasetApi:
|
|
|
683
711
|
|
|
684
712
|
|
|
685
713
|
@validate_call
|
|
686
|
-
def
|
|
714
|
+
def get_saved_query_info_queries_query_name_get_with_http_info(
|
|
687
715
|
self,
|
|
688
|
-
|
|
689
|
-
|
|
716
|
+
engine_name: StrictStr,
|
|
717
|
+
query_name: StrictStr,
|
|
690
718
|
_request_timeout: Union[
|
|
691
719
|
None,
|
|
692
720
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -699,15 +727,15 @@ class DatasetApi:
|
|
|
699
727
|
_content_type: Optional[StrictStr] = None,
|
|
700
728
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
701
729
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
702
|
-
) -> ApiResponse[
|
|
703
|
-
"""
|
|
730
|
+
) -> ApiResponse[SavedQueryInfoResponse]:
|
|
731
|
+
"""Get Saved Query Details
|
|
704
732
|
|
|
705
|
-
|
|
733
|
+
Get information about a specific saved query.
|
|
706
734
|
|
|
707
|
-
:param
|
|
708
|
-
:type
|
|
709
|
-
:param
|
|
710
|
-
:type
|
|
735
|
+
:param engine_name: (required)
|
|
736
|
+
:type engine_name: str
|
|
737
|
+
:param query_name: (required)
|
|
738
|
+
:type query_name: str
|
|
711
739
|
:param _request_timeout: timeout setting for this request. If one
|
|
712
740
|
number provided, it will be total request
|
|
713
741
|
timeout. It can also be a pair (tuple) of
|
|
@@ -730,9 +758,9 @@ class DatasetApi:
|
|
|
730
758
|
:return: Returns the result object.
|
|
731
759
|
""" # noqa: E501
|
|
732
760
|
|
|
733
|
-
_param = self.
|
|
734
|
-
|
|
735
|
-
|
|
761
|
+
_param = self._get_saved_query_info_queries_query_name_get_serialize(
|
|
762
|
+
engine_name=engine_name,
|
|
763
|
+
query_name=query_name,
|
|
736
764
|
_request_auth=_request_auth,
|
|
737
765
|
_content_type=_content_type,
|
|
738
766
|
_headers=_headers,
|
|
@@ -740,7 +768,7 @@ class DatasetApi:
|
|
|
740
768
|
)
|
|
741
769
|
|
|
742
770
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
743
|
-
'200': "
|
|
771
|
+
'200': "SavedQueryInfoResponse",
|
|
744
772
|
'422': "HTTPValidationError",
|
|
745
773
|
}
|
|
746
774
|
response_data = self.api_client.call_api(
|
|
@@ -755,10 +783,10 @@ class DatasetApi:
|
|
|
755
783
|
|
|
756
784
|
|
|
757
785
|
@validate_call
|
|
758
|
-
def
|
|
786
|
+
def get_saved_query_info_queries_query_name_get_without_preload_content(
|
|
759
787
|
self,
|
|
760
|
-
|
|
761
|
-
|
|
788
|
+
engine_name: StrictStr,
|
|
789
|
+
query_name: StrictStr,
|
|
762
790
|
_request_timeout: Union[
|
|
763
791
|
None,
|
|
764
792
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -772,14 +800,14 @@ class DatasetApi:
|
|
|
772
800
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
773
801
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
774
802
|
) -> RESTResponseType:
|
|
775
|
-
"""
|
|
803
|
+
"""Get Saved Query Details
|
|
776
804
|
|
|
777
|
-
|
|
805
|
+
Get information about a specific saved query.
|
|
778
806
|
|
|
779
|
-
:param
|
|
780
|
-
:type
|
|
781
|
-
:param
|
|
782
|
-
:type
|
|
807
|
+
:param engine_name: (required)
|
|
808
|
+
:type engine_name: str
|
|
809
|
+
:param query_name: (required)
|
|
810
|
+
:type query_name: str
|
|
783
811
|
:param _request_timeout: timeout setting for this request. If one
|
|
784
812
|
number provided, it will be total request
|
|
785
813
|
timeout. It can also be a pair (tuple) of
|
|
@@ -802,9 +830,9 @@ class DatasetApi:
|
|
|
802
830
|
:return: Returns the result object.
|
|
803
831
|
""" # noqa: E501
|
|
804
832
|
|
|
805
|
-
_param = self.
|
|
806
|
-
|
|
807
|
-
|
|
833
|
+
_param = self._get_saved_query_info_queries_query_name_get_serialize(
|
|
834
|
+
engine_name=engine_name,
|
|
835
|
+
query_name=query_name,
|
|
808
836
|
_request_auth=_request_auth,
|
|
809
837
|
_content_type=_content_type,
|
|
810
838
|
_headers=_headers,
|
|
@@ -812,7 +840,7 @@ class DatasetApi:
|
|
|
812
840
|
)
|
|
813
841
|
|
|
814
842
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
815
|
-
'200': "
|
|
843
|
+
'200': "SavedQueryInfoResponse",
|
|
816
844
|
'422': "HTTPValidationError",
|
|
817
845
|
}
|
|
818
846
|
response_data = self.api_client.call_api(
|
|
@@ -822,10 +850,10 @@ class DatasetApi:
|
|
|
822
850
|
return response_data.response
|
|
823
851
|
|
|
824
852
|
|
|
825
|
-
def
|
|
853
|
+
def _get_saved_query_info_queries_query_name_get_serialize(
|
|
826
854
|
self,
|
|
827
|
-
|
|
828
|
-
|
|
855
|
+
engine_name,
|
|
856
|
+
query_name,
|
|
829
857
|
_request_auth,
|
|
830
858
|
_content_type,
|
|
831
859
|
_headers,
|
|
@@ -847,12 +875,12 @@ class DatasetApi:
|
|
|
847
875
|
_body_params: Optional[bytes] = None
|
|
848
876
|
|
|
849
877
|
# process the path parameters
|
|
850
|
-
if
|
|
851
|
-
_path_params['
|
|
878
|
+
if engine_name is not None:
|
|
879
|
+
_path_params['engine_name'] = engine_name
|
|
880
|
+
if query_name is not None:
|
|
881
|
+
_path_params['query_name'] = query_name
|
|
852
882
|
# process the query parameters
|
|
853
883
|
# process the header parameters
|
|
854
|
-
if x_api_key is not None:
|
|
855
|
-
_header_params['x-api-key'] = x_api_key
|
|
856
884
|
# process the form parameters
|
|
857
885
|
# process the body parameter
|
|
858
886
|
|
|
@@ -871,8 +899,8 @@ class DatasetApi:
|
|
|
871
899
|
]
|
|
872
900
|
|
|
873
901
|
return self.api_client.param_serialize(
|
|
874
|
-
method='
|
|
875
|
-
resource_path='/
|
|
902
|
+
method='GET',
|
|
903
|
+
resource_path='/engines/{engine_name}/queries/{query_name}',
|
|
876
904
|
path_params=_path_params,
|
|
877
905
|
query_params=_query_params,
|
|
878
906
|
header_params=_header_params,
|
|
@@ -889,9 +917,9 @@ class DatasetApi:
|
|
|
889
917
|
|
|
890
918
|
|
|
891
919
|
@validate_call
|
|
892
|
-
def
|
|
920
|
+
def list_saved_queries_queries_get(
|
|
893
921
|
self,
|
|
894
|
-
|
|
922
|
+
engine_name: StrictStr,
|
|
895
923
|
_request_timeout: Union[
|
|
896
924
|
None,
|
|
897
925
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -904,13 +932,13 @@ class DatasetApi:
|
|
|
904
932
|
_content_type: Optional[StrictStr] = None,
|
|
905
933
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
906
934
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
907
|
-
) ->
|
|
908
|
-
"""List
|
|
935
|
+
) -> SavedQueryListResponse:
|
|
936
|
+
"""List Saved Queries
|
|
909
937
|
|
|
910
|
-
List
|
|
938
|
+
List all available saved queries for an engine.
|
|
911
939
|
|
|
912
|
-
:param
|
|
913
|
-
:type
|
|
940
|
+
:param engine_name: (required)
|
|
941
|
+
:type engine_name: str
|
|
914
942
|
:param _request_timeout: timeout setting for this request. If one
|
|
915
943
|
number provided, it will be total request
|
|
916
944
|
timeout. It can also be a pair (tuple) of
|
|
@@ -933,8 +961,8 @@ class DatasetApi:
|
|
|
933
961
|
:return: Returns the result object.
|
|
934
962
|
""" # noqa: E501
|
|
935
963
|
|
|
936
|
-
_param = self.
|
|
937
|
-
|
|
964
|
+
_param = self._list_saved_queries_queries_get_serialize(
|
|
965
|
+
engine_name=engine_name,
|
|
938
966
|
_request_auth=_request_auth,
|
|
939
967
|
_content_type=_content_type,
|
|
940
968
|
_headers=_headers,
|
|
@@ -942,8 +970,7 @@ class DatasetApi:
|
|
|
942
970
|
)
|
|
943
971
|
|
|
944
972
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
945
|
-
'200': "
|
|
946
|
-
'422': "HTTPValidationError",
|
|
973
|
+
'200': "SavedQueryListResponse",
|
|
947
974
|
}
|
|
948
975
|
response_data = self.api_client.call_api(
|
|
949
976
|
*_param,
|
|
@@ -957,9 +984,9 @@ class DatasetApi:
|
|
|
957
984
|
|
|
958
985
|
|
|
959
986
|
@validate_call
|
|
960
|
-
def
|
|
987
|
+
def list_saved_queries_queries_get_with_http_info(
|
|
961
988
|
self,
|
|
962
|
-
|
|
989
|
+
engine_name: StrictStr,
|
|
963
990
|
_request_timeout: Union[
|
|
964
991
|
None,
|
|
965
992
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -972,13 +999,13 @@ class DatasetApi:
|
|
|
972
999
|
_content_type: Optional[StrictStr] = None,
|
|
973
1000
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
974
1001
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
975
|
-
) -> ApiResponse[
|
|
976
|
-
"""List
|
|
1002
|
+
) -> ApiResponse[SavedQueryListResponse]:
|
|
1003
|
+
"""List Saved Queries
|
|
977
1004
|
|
|
978
|
-
List
|
|
1005
|
+
List all available saved queries for an engine.
|
|
979
1006
|
|
|
980
|
-
:param
|
|
981
|
-
:type
|
|
1007
|
+
:param engine_name: (required)
|
|
1008
|
+
:type engine_name: str
|
|
982
1009
|
:param _request_timeout: timeout setting for this request. If one
|
|
983
1010
|
number provided, it will be total request
|
|
984
1011
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1001,8 +1028,8 @@ class DatasetApi:
|
|
|
1001
1028
|
:return: Returns the result object.
|
|
1002
1029
|
""" # noqa: E501
|
|
1003
1030
|
|
|
1004
|
-
_param = self.
|
|
1005
|
-
|
|
1031
|
+
_param = self._list_saved_queries_queries_get_serialize(
|
|
1032
|
+
engine_name=engine_name,
|
|
1006
1033
|
_request_auth=_request_auth,
|
|
1007
1034
|
_content_type=_content_type,
|
|
1008
1035
|
_headers=_headers,
|
|
@@ -1010,8 +1037,7 @@ class DatasetApi:
|
|
|
1010
1037
|
)
|
|
1011
1038
|
|
|
1012
1039
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
1013
|
-
'200': "
|
|
1014
|
-
'422': "HTTPValidationError",
|
|
1040
|
+
'200': "SavedQueryListResponse",
|
|
1015
1041
|
}
|
|
1016
1042
|
response_data = self.api_client.call_api(
|
|
1017
1043
|
*_param,
|
|
@@ -1025,9 +1051,9 @@ class DatasetApi:
|
|
|
1025
1051
|
|
|
1026
1052
|
|
|
1027
1053
|
@validate_call
|
|
1028
|
-
def
|
|
1054
|
+
def list_saved_queries_queries_get_without_preload_content(
|
|
1029
1055
|
self,
|
|
1030
|
-
|
|
1056
|
+
engine_name: StrictStr,
|
|
1031
1057
|
_request_timeout: Union[
|
|
1032
1058
|
None,
|
|
1033
1059
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1041,12 +1067,12 @@ class DatasetApi:
|
|
|
1041
1067
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1042
1068
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1043
1069
|
) -> RESTResponseType:
|
|
1044
|
-
"""List
|
|
1070
|
+
"""List Saved Queries
|
|
1045
1071
|
|
|
1046
|
-
List
|
|
1072
|
+
List all available saved queries for an engine.
|
|
1047
1073
|
|
|
1048
|
-
:param
|
|
1049
|
-
:type
|
|
1074
|
+
:param engine_name: (required)
|
|
1075
|
+
:type engine_name: str
|
|
1050
1076
|
:param _request_timeout: timeout setting for this request. If one
|
|
1051
1077
|
number provided, it will be total request
|
|
1052
1078
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1069,8 +1095,8 @@ class DatasetApi:
|
|
|
1069
1095
|
:return: Returns the result object.
|
|
1070
1096
|
""" # noqa: E501
|
|
1071
1097
|
|
|
1072
|
-
_param = self.
|
|
1073
|
-
|
|
1098
|
+
_param = self._list_saved_queries_queries_get_serialize(
|
|
1099
|
+
engine_name=engine_name,
|
|
1074
1100
|
_request_auth=_request_auth,
|
|
1075
1101
|
_content_type=_content_type,
|
|
1076
1102
|
_headers=_headers,
|
|
@@ -1078,8 +1104,7 @@ class DatasetApi:
|
|
|
1078
1104
|
)
|
|
1079
1105
|
|
|
1080
1106
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
1081
|
-
'200': "
|
|
1082
|
-
'422': "HTTPValidationError",
|
|
1107
|
+
'200': "SavedQueryListResponse",
|
|
1083
1108
|
}
|
|
1084
1109
|
response_data = self.api_client.call_api(
|
|
1085
1110
|
*_param,
|
|
@@ -1088,9 +1113,9 @@ class DatasetApi:
|
|
|
1088
1113
|
return response_data.response
|
|
1089
1114
|
|
|
1090
1115
|
|
|
1091
|
-
def
|
|
1116
|
+
def _list_saved_queries_queries_get_serialize(
|
|
1092
1117
|
self,
|
|
1093
|
-
|
|
1118
|
+
engine_name,
|
|
1094
1119
|
_request_auth,
|
|
1095
1120
|
_content_type,
|
|
1096
1121
|
_headers,
|
|
@@ -1112,10 +1137,10 @@ class DatasetApi:
|
|
|
1112
1137
|
_body_params: Optional[bytes] = None
|
|
1113
1138
|
|
|
1114
1139
|
# process the path parameters
|
|
1140
|
+
if engine_name is not None:
|
|
1141
|
+
_path_params['engine_name'] = engine_name
|
|
1115
1142
|
# process the query parameters
|
|
1116
1143
|
# process the header parameters
|
|
1117
|
-
if x_api_key is not None:
|
|
1118
|
-
_header_params['x-api-key'] = x_api_key
|
|
1119
1144
|
# process the form parameters
|
|
1120
1145
|
# process the body parameter
|
|
1121
1146
|
|
|
@@ -1135,7 +1160,7 @@ class DatasetApi:
|
|
|
1135
1160
|
|
|
1136
1161
|
return self.api_client.param_serialize(
|
|
1137
1162
|
method='GET',
|
|
1138
|
-
resource_path='/
|
|
1163
|
+
resource_path='/engines/{engine_name}/queries',
|
|
1139
1164
|
path_params=_path_params,
|
|
1140
1165
|
query_params=_query_params,
|
|
1141
1166
|
header_params=_header_params,
|