shaped 2.0.0__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.0.dist-info → shaped-2.0.2.dist-info}/METADATA +119 -56
- 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.0.dist-info/RECORD +0 -73
- shaped-2.0.0.dist-info/entry_points.txt +0 -2
- {shaped-2.0.0.dist-info → shaped-2.0.2.dist-info}/WHEEL +0 -0
- {shaped-2.0.0.dist-info → shaped-2.0.2.dist-info}/top_level.txt +0 -0
- {shaped-2.0.0.dist-info → shaped-2.0.2.dist-info}/zip-safe +0 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Shaped API
|
|
5
|
+
|
|
6
|
+
Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
import pprint
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import json
|
|
19
|
+
|
|
20
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
|
|
21
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from shaped.autogen.models.batch_size2 import BatchSize2
|
|
23
|
+
from shaped.autogen.models.embedding_dims import EmbeddingDims
|
|
24
|
+
from shaped.autogen.models.lr2 import Lr2
|
|
25
|
+
from shaped.autogen.models.negative_samples_count import NegativeSamplesCount
|
|
26
|
+
from shaped.autogen.models.training_strategy import TrainingStrategy
|
|
27
|
+
from shaped.autogen.models.weight_decay import WeightDecay
|
|
28
|
+
from typing import Optional, Set
|
|
29
|
+
from typing_extensions import Self
|
|
30
|
+
|
|
31
|
+
class ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig(BaseModel):
|
|
32
|
+
"""
|
|
33
|
+
ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig
|
|
34
|
+
""" # noqa: E501
|
|
35
|
+
policy_type: Optional[StrictStr] = 'two-tower'
|
|
36
|
+
name: Optional[StrictStr] = None
|
|
37
|
+
event_values: Optional[List[StrictStr]] = None
|
|
38
|
+
batch_size: Optional[BatchSize2] = None
|
|
39
|
+
n_epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
|
|
40
|
+
device: Optional[StrictStr] = None
|
|
41
|
+
negative_samples_count: Optional[NegativeSamplesCount] = None
|
|
42
|
+
embedding_dims: Optional[EmbeddingDims] = None
|
|
43
|
+
lr: Optional[Lr2] = None
|
|
44
|
+
weight_decay: Optional[WeightDecay] = None
|
|
45
|
+
use_item_ids_as_features: Optional[StrictBool] = True
|
|
46
|
+
strategy: Optional[TrainingStrategy] = None
|
|
47
|
+
patience: Optional[StrictInt] = Field(default=5, description="Number of epochs to wait without improvement before early stopping.")
|
|
48
|
+
num_workers: Optional[StrictInt] = 0
|
|
49
|
+
__properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "n_epochs", "device", "negative_samples_count", "embedding_dims", "lr", "weight_decay", "use_item_ids_as_features", "strategy", "patience", "num_workers"]
|
|
50
|
+
|
|
51
|
+
@field_validator('policy_type')
|
|
52
|
+
def policy_type_validate_enum(cls, value):
|
|
53
|
+
"""Validates the enum"""
|
|
54
|
+
if value is None:
|
|
55
|
+
return value
|
|
56
|
+
|
|
57
|
+
if value not in set(['two-tower']):
|
|
58
|
+
raise ValueError("must be one of enum values ('two-tower')")
|
|
59
|
+
return value
|
|
60
|
+
|
|
61
|
+
model_config = ConfigDict(
|
|
62
|
+
populate_by_name=True,
|
|
63
|
+
validate_assignment=True,
|
|
64
|
+
protected_namespaces=(),
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
def to_str(self) -> str:
|
|
69
|
+
"""Returns the string representation of the model using alias"""
|
|
70
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
71
|
+
|
|
72
|
+
def to_json(self) -> str:
|
|
73
|
+
"""Returns the JSON representation of the model using alias"""
|
|
74
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
75
|
+
return json.dumps(self.to_dict())
|
|
76
|
+
|
|
77
|
+
@classmethod
|
|
78
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
79
|
+
"""Create an instance of ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig from a JSON string"""
|
|
80
|
+
return cls.from_dict(json.loads(json_str))
|
|
81
|
+
|
|
82
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
83
|
+
"""Return the dictionary representation of the model using alias.
|
|
84
|
+
|
|
85
|
+
This has the following differences from calling pydantic's
|
|
86
|
+
`self.model_dump(by_alias=True)`:
|
|
87
|
+
|
|
88
|
+
* `None` is only added to the output dict for nullable fields that
|
|
89
|
+
were set at model initialization. Other fields with value `None`
|
|
90
|
+
are ignored.
|
|
91
|
+
"""
|
|
92
|
+
excluded_fields: Set[str] = set([
|
|
93
|
+
])
|
|
94
|
+
|
|
95
|
+
_dict = self.model_dump(
|
|
96
|
+
by_alias=True,
|
|
97
|
+
exclude=excluded_fields,
|
|
98
|
+
exclude_none=True,
|
|
99
|
+
)
|
|
100
|
+
# override the default output from pydantic by calling `to_dict()` of batch_size
|
|
101
|
+
if self.batch_size:
|
|
102
|
+
_dict['batch_size'] = self.batch_size.to_dict()
|
|
103
|
+
# override the default output from pydantic by calling `to_dict()` of negative_samples_count
|
|
104
|
+
if self.negative_samples_count:
|
|
105
|
+
_dict['negative_samples_count'] = self.negative_samples_count.to_dict()
|
|
106
|
+
# override the default output from pydantic by calling `to_dict()` of embedding_dims
|
|
107
|
+
if self.embedding_dims:
|
|
108
|
+
_dict['embedding_dims'] = self.embedding_dims.to_dict()
|
|
109
|
+
# override the default output from pydantic by calling `to_dict()` of lr
|
|
110
|
+
if self.lr:
|
|
111
|
+
_dict['lr'] = self.lr.to_dict()
|
|
112
|
+
# override the default output from pydantic by calling `to_dict()` of weight_decay
|
|
113
|
+
if self.weight_decay:
|
|
114
|
+
_dict['weight_decay'] = self.weight_decay.to_dict()
|
|
115
|
+
# set to None if name (nullable) is None
|
|
116
|
+
# and model_fields_set contains the field
|
|
117
|
+
if self.name is None and "name" in self.model_fields_set:
|
|
118
|
+
_dict['name'] = None
|
|
119
|
+
|
|
120
|
+
# set to None if event_values (nullable) is None
|
|
121
|
+
# and model_fields_set contains the field
|
|
122
|
+
if self.event_values is None and "event_values" in self.model_fields_set:
|
|
123
|
+
_dict['event_values'] = None
|
|
124
|
+
|
|
125
|
+
# set to None if device (nullable) is None
|
|
126
|
+
# and model_fields_set contains the field
|
|
127
|
+
if self.device is None and "device" in self.model_fields_set:
|
|
128
|
+
_dict['device'] = None
|
|
129
|
+
|
|
130
|
+
return _dict
|
|
131
|
+
|
|
132
|
+
@classmethod
|
|
133
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
134
|
+
"""Create an instance of ShapedInternalRecsysPoliciesTwoTowerModelPolicyTwoTowerModelPolicyTwoTowerModelPolicyConfig from a dict"""
|
|
135
|
+
if obj is None:
|
|
136
|
+
return None
|
|
137
|
+
|
|
138
|
+
if not isinstance(obj, dict):
|
|
139
|
+
return cls.model_validate(obj)
|
|
140
|
+
|
|
141
|
+
_obj = cls.model_validate({
|
|
142
|
+
"policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'two-tower',
|
|
143
|
+
"name": obj.get("name"),
|
|
144
|
+
"event_values": obj.get("event_values"),
|
|
145
|
+
"batch_size": BatchSize2.from_dict(obj["batch_size"]) if obj.get("batch_size") is not None else None,
|
|
146
|
+
"n_epochs": obj.get("n_epochs") if obj.get("n_epochs") is not None else 1,
|
|
147
|
+
"device": obj.get("device"),
|
|
148
|
+
"negative_samples_count": NegativeSamplesCount.from_dict(obj["negative_samples_count"]) if obj.get("negative_samples_count") is not None else None,
|
|
149
|
+
"embedding_dims": EmbeddingDims.from_dict(obj["embedding_dims"]) if obj.get("embedding_dims") is not None else None,
|
|
150
|
+
"lr": Lr2.from_dict(obj["lr"]) if obj.get("lr") is not None else None,
|
|
151
|
+
"weight_decay": WeightDecay.from_dict(obj["weight_decay"]) if obj.get("weight_decay") is not None else None,
|
|
152
|
+
"use_item_ids_as_features": obj.get("use_item_ids_as_features") if obj.get("use_item_ids_as_features") is not None else True,
|
|
153
|
+
"strategy": obj.get("strategy"),
|
|
154
|
+
"patience": obj.get("patience") if obj.get("patience") is not None else 5,
|
|
155
|
+
"num_workers": obj.get("num_workers") if obj.get("num_workers") is not None else 0
|
|
156
|
+
})
|
|
157
|
+
return _obj
|
|
158
|
+
|
|
159
|
+
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Shaped API
|
|
5
|
+
|
|
6
|
+
Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
import pprint
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import json
|
|
19
|
+
|
|
20
|
+
from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
|
|
21
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from shaped.autogen.models.distance_function import DistanceFunction
|
|
23
|
+
from shaped.autogen.models.encoding_pooling_strategy import EncodingPoolingStrategy
|
|
24
|
+
from typing import Optional, Set
|
|
25
|
+
from typing_extensions import Self
|
|
26
|
+
|
|
27
|
+
class ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig(BaseModel):
|
|
28
|
+
"""
|
|
29
|
+
ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig
|
|
30
|
+
""" # noqa: E501
|
|
31
|
+
policy_type: Optional[StrictStr] = 'user-item-content-similarity'
|
|
32
|
+
name: Optional[StrictStr] = None
|
|
33
|
+
event_values: Optional[List[StrictStr]] = None
|
|
34
|
+
pool_fn: Optional[EncodingPoolingStrategy] = None
|
|
35
|
+
distance_fn: Optional[DistanceFunction] = None
|
|
36
|
+
item_feature_names: Optional[List[StrictStr]] = None
|
|
37
|
+
user_feature_names: Optional[List[StrictStr]] = None
|
|
38
|
+
__properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "pool_fn", "distance_fn", "item_feature_names", "user_feature_names"]
|
|
39
|
+
|
|
40
|
+
@field_validator('policy_type')
|
|
41
|
+
def policy_type_validate_enum(cls, value):
|
|
42
|
+
"""Validates the enum"""
|
|
43
|
+
if value is None:
|
|
44
|
+
return value
|
|
45
|
+
|
|
46
|
+
if value not in set(['user-item-content-similarity']):
|
|
47
|
+
raise ValueError("must be one of enum values ('user-item-content-similarity')")
|
|
48
|
+
return value
|
|
49
|
+
|
|
50
|
+
model_config = ConfigDict(
|
|
51
|
+
populate_by_name=True,
|
|
52
|
+
validate_assignment=True,
|
|
53
|
+
protected_namespaces=(),
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
def to_str(self) -> str:
|
|
58
|
+
"""Returns the string representation of the model using alias"""
|
|
59
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
60
|
+
|
|
61
|
+
def to_json(self) -> str:
|
|
62
|
+
"""Returns the JSON representation of the model using alias"""
|
|
63
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
64
|
+
return json.dumps(self.to_dict())
|
|
65
|
+
|
|
66
|
+
@classmethod
|
|
67
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
68
|
+
"""Create an instance of ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig from a JSON string"""
|
|
69
|
+
return cls.from_dict(json.loads(json_str))
|
|
70
|
+
|
|
71
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
72
|
+
"""Return the dictionary representation of the model using alias.
|
|
73
|
+
|
|
74
|
+
This has the following differences from calling pydantic's
|
|
75
|
+
`self.model_dump(by_alias=True)`:
|
|
76
|
+
|
|
77
|
+
* `None` is only added to the output dict for nullable fields that
|
|
78
|
+
were set at model initialization. Other fields with value `None`
|
|
79
|
+
are ignored.
|
|
80
|
+
"""
|
|
81
|
+
excluded_fields: Set[str] = set([
|
|
82
|
+
])
|
|
83
|
+
|
|
84
|
+
_dict = self.model_dump(
|
|
85
|
+
by_alias=True,
|
|
86
|
+
exclude=excluded_fields,
|
|
87
|
+
exclude_none=True,
|
|
88
|
+
)
|
|
89
|
+
# set to None if name (nullable) is None
|
|
90
|
+
# and model_fields_set contains the field
|
|
91
|
+
if self.name is None and "name" in self.model_fields_set:
|
|
92
|
+
_dict['name'] = None
|
|
93
|
+
|
|
94
|
+
# set to None if event_values (nullable) is None
|
|
95
|
+
# and model_fields_set contains the field
|
|
96
|
+
if self.event_values is None and "event_values" in self.model_fields_set:
|
|
97
|
+
_dict['event_values'] = None
|
|
98
|
+
|
|
99
|
+
# set to None if item_feature_names (nullable) is None
|
|
100
|
+
# and model_fields_set contains the field
|
|
101
|
+
if self.item_feature_names is None and "item_feature_names" in self.model_fields_set:
|
|
102
|
+
_dict['item_feature_names'] = None
|
|
103
|
+
|
|
104
|
+
# set to None if user_feature_names (nullable) is None
|
|
105
|
+
# and model_fields_set contains the field
|
|
106
|
+
if self.user_feature_names is None and "user_feature_names" in self.model_fields_set:
|
|
107
|
+
_dict['user_feature_names'] = None
|
|
108
|
+
|
|
109
|
+
return _dict
|
|
110
|
+
|
|
111
|
+
@classmethod
|
|
112
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
113
|
+
"""Create an instance of ShapedInternalRecsysPoliciesUserItemContentSimilarityModelPolicyUserItemContentSimilarityModelPolicyConfig from a dict"""
|
|
114
|
+
if obj is None:
|
|
115
|
+
return None
|
|
116
|
+
|
|
117
|
+
if not isinstance(obj, dict):
|
|
118
|
+
return cls.model_validate(obj)
|
|
119
|
+
|
|
120
|
+
_obj = cls.model_validate({
|
|
121
|
+
"policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'user-item-content-similarity',
|
|
122
|
+
"name": obj.get("name"),
|
|
123
|
+
"event_values": obj.get("event_values"),
|
|
124
|
+
"pool_fn": obj.get("pool_fn"),
|
|
125
|
+
"distance_fn": obj.get("distance_fn"),
|
|
126
|
+
"item_feature_names": obj.get("item_feature_names"),
|
|
127
|
+
"user_feature_names": obj.get("user_feature_names")
|
|
128
|
+
})
|
|
129
|
+
return _obj
|
|
130
|
+
|
|
131
|
+
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Shaped API
|
|
5
|
+
|
|
6
|
+
Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
import pprint
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import json
|
|
19
|
+
|
|
20
|
+
from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr, field_validator
|
|
21
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from shaped.autogen.models.n_epochs2 import NEpochs2
|
|
23
|
+
from shaped.autogen.models.val_split import ValSplit
|
|
24
|
+
from typing import Optional, Set
|
|
25
|
+
from typing_extensions import Self
|
|
26
|
+
|
|
27
|
+
class ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig(BaseModel):
|
|
28
|
+
"""
|
|
29
|
+
ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig
|
|
30
|
+
""" # noqa: E501
|
|
31
|
+
policy_type: Optional[StrictStr] = 'widedeep'
|
|
32
|
+
name: Optional[StrictStr] = None
|
|
33
|
+
val_split: Optional[ValSplit] = None
|
|
34
|
+
n_epochs: Optional[NEpochs2] = None
|
|
35
|
+
num_workers: Optional[StrictInt] = 0
|
|
36
|
+
additional_properties: Dict[str, Any] = {}
|
|
37
|
+
__properties: ClassVar[List[str]] = ["policy_type", "name", "val_split", "n_epochs", "num_workers"]
|
|
38
|
+
|
|
39
|
+
@field_validator('policy_type')
|
|
40
|
+
def policy_type_validate_enum(cls, value):
|
|
41
|
+
"""Validates the enum"""
|
|
42
|
+
if value is None:
|
|
43
|
+
return value
|
|
44
|
+
|
|
45
|
+
if value not in set(['widedeep']):
|
|
46
|
+
raise ValueError("must be one of enum values ('widedeep')")
|
|
47
|
+
return value
|
|
48
|
+
|
|
49
|
+
model_config = ConfigDict(
|
|
50
|
+
populate_by_name=True,
|
|
51
|
+
validate_assignment=True,
|
|
52
|
+
protected_namespaces=(),
|
|
53
|
+
)
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
def to_str(self) -> str:
|
|
57
|
+
"""Returns the string representation of the model using alias"""
|
|
58
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
59
|
+
|
|
60
|
+
def to_json(self) -> str:
|
|
61
|
+
"""Returns the JSON representation of the model using alias"""
|
|
62
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
63
|
+
return json.dumps(self.to_dict())
|
|
64
|
+
|
|
65
|
+
@classmethod
|
|
66
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
67
|
+
"""Create an instance of ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig from a JSON string"""
|
|
68
|
+
return cls.from_dict(json.loads(json_str))
|
|
69
|
+
|
|
70
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
71
|
+
"""Return the dictionary representation of the model using alias.
|
|
72
|
+
|
|
73
|
+
This has the following differences from calling pydantic's
|
|
74
|
+
`self.model_dump(by_alias=True)`:
|
|
75
|
+
|
|
76
|
+
* `None` is only added to the output dict for nullable fields that
|
|
77
|
+
were set at model initialization. Other fields with value `None`
|
|
78
|
+
are ignored.
|
|
79
|
+
* Fields in `self.additional_properties` are added to the output dict.
|
|
80
|
+
"""
|
|
81
|
+
excluded_fields: Set[str] = set([
|
|
82
|
+
"additional_properties",
|
|
83
|
+
])
|
|
84
|
+
|
|
85
|
+
_dict = self.model_dump(
|
|
86
|
+
by_alias=True,
|
|
87
|
+
exclude=excluded_fields,
|
|
88
|
+
exclude_none=True,
|
|
89
|
+
)
|
|
90
|
+
# override the default output from pydantic by calling `to_dict()` of val_split
|
|
91
|
+
if self.val_split:
|
|
92
|
+
_dict['val_split'] = self.val_split.to_dict()
|
|
93
|
+
# override the default output from pydantic by calling `to_dict()` of n_epochs
|
|
94
|
+
if self.n_epochs:
|
|
95
|
+
_dict['n_epochs'] = self.n_epochs.to_dict()
|
|
96
|
+
# puts key-value pairs in additional_properties in the top level
|
|
97
|
+
if self.additional_properties is not None:
|
|
98
|
+
for _key, _value in self.additional_properties.items():
|
|
99
|
+
_dict[_key] = _value
|
|
100
|
+
|
|
101
|
+
# set to None if name (nullable) is None
|
|
102
|
+
# and model_fields_set contains the field
|
|
103
|
+
if self.name is None and "name" in self.model_fields_set:
|
|
104
|
+
_dict['name'] = None
|
|
105
|
+
|
|
106
|
+
return _dict
|
|
107
|
+
|
|
108
|
+
@classmethod
|
|
109
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
110
|
+
"""Create an instance of ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig from a dict"""
|
|
111
|
+
if obj is None:
|
|
112
|
+
return None
|
|
113
|
+
|
|
114
|
+
if not isinstance(obj, dict):
|
|
115
|
+
return cls.model_validate(obj)
|
|
116
|
+
|
|
117
|
+
_obj = cls.model_validate({
|
|
118
|
+
"policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'widedeep',
|
|
119
|
+
"name": obj.get("name"),
|
|
120
|
+
"val_split": ValSplit.from_dict(obj["val_split"]) if obj.get("val_split") is not None else None,
|
|
121
|
+
"n_epochs": NEpochs2.from_dict(obj["n_epochs"]) if obj.get("n_epochs") is not None else None,
|
|
122
|
+
"num_workers": obj.get("num_workers") if obj.get("num_workers") is not None else 0
|
|
123
|
+
})
|
|
124
|
+
# store additional fields in additional_properties
|
|
125
|
+
for _key in obj.keys():
|
|
126
|
+
if _key not in cls.__properties:
|
|
127
|
+
_obj.additional_properties[_key] = obj.get(_key)
|
|
128
|
+
|
|
129
|
+
return _obj
|
|
130
|
+
|
|
131
|
+
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Shaped API
|
|
5
|
+
|
|
6
|
+
Welcome to Shaped's API reference docs. These provide a detailed view of the endpoints and CLI commands that Shaped provides and brief explanations of how they should be used. The Shaped API has four main endpoints: **Tables** - Provision and manage batch and real-time data connectors. **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc. **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more. **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture. The base URL for each endpoint is: `https://api.shaped.ai/v2`
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 2.0.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
import pprint
|
|
17
|
+
import re # noqa: F401
|
|
18
|
+
import json
|
|
19
|
+
|
|
20
|
+
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
|
|
21
|
+
from typing import Any, ClassVar, Dict, List, Optional
|
|
22
|
+
from shaped.autogen.models.learning_rate3 import LearningRate3
|
|
23
|
+
from shaped.autogen.models.max_depth import MaxDepth
|
|
24
|
+
from shaped.autogen.models.max_leaves import MaxLeaves
|
|
25
|
+
from shaped.autogen.models.mode2 import Mode2
|
|
26
|
+
from shaped.autogen.models.n_estimators import NEstimators
|
|
27
|
+
from typing import Optional, Set
|
|
28
|
+
from typing_extensions import Self
|
|
29
|
+
|
|
30
|
+
class ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig(BaseModel):
|
|
31
|
+
"""
|
|
32
|
+
ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig
|
|
33
|
+
""" # noqa: E501
|
|
34
|
+
policy_type: Optional[StrictStr] = 'xgboost'
|
|
35
|
+
name: Optional[StrictStr] = None
|
|
36
|
+
event_values: Optional[List[StrictStr]] = None
|
|
37
|
+
mode: Optional[Mode2] = None
|
|
38
|
+
n_estimators: Optional[NEstimators] = None
|
|
39
|
+
max_depth: Optional[MaxDepth] = None
|
|
40
|
+
max_leaves: Optional[MaxLeaves] = None
|
|
41
|
+
n_jobs: Optional[StrictInt] = -1
|
|
42
|
+
learning_rate: Optional[LearningRate3] = None
|
|
43
|
+
min_child_weight: Optional[StrictInt] = Field(default=1, description="Minimum sum of instance weight needed in a child node.")
|
|
44
|
+
use_user_ids_as_features: Optional[StrictBool] = True
|
|
45
|
+
use_item_ids_as_features: Optional[StrictBool] = True
|
|
46
|
+
__properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "mode", "n_estimators", "max_depth", "max_leaves", "n_jobs", "learning_rate", "min_child_weight", "use_user_ids_as_features", "use_item_ids_as_features"]
|
|
47
|
+
|
|
48
|
+
@field_validator('policy_type')
|
|
49
|
+
def policy_type_validate_enum(cls, value):
|
|
50
|
+
"""Validates the enum"""
|
|
51
|
+
if value is None:
|
|
52
|
+
return value
|
|
53
|
+
|
|
54
|
+
if value not in set(['xgboost']):
|
|
55
|
+
raise ValueError("must be one of enum values ('xgboost')")
|
|
56
|
+
return value
|
|
57
|
+
|
|
58
|
+
model_config = ConfigDict(
|
|
59
|
+
populate_by_name=True,
|
|
60
|
+
validate_assignment=True,
|
|
61
|
+
protected_namespaces=(),
|
|
62
|
+
)
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
def to_str(self) -> str:
|
|
66
|
+
"""Returns the string representation of the model using alias"""
|
|
67
|
+
return pprint.pformat(self.model_dump(by_alias=True))
|
|
68
|
+
|
|
69
|
+
def to_json(self) -> str:
|
|
70
|
+
"""Returns the JSON representation of the model using alias"""
|
|
71
|
+
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
72
|
+
return json.dumps(self.to_dict())
|
|
73
|
+
|
|
74
|
+
@classmethod
|
|
75
|
+
def from_json(cls, json_str: str) -> Optional[Self]:
|
|
76
|
+
"""Create an instance of ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig from a JSON string"""
|
|
77
|
+
return cls.from_dict(json.loads(json_str))
|
|
78
|
+
|
|
79
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
80
|
+
"""Return the dictionary representation of the model using alias.
|
|
81
|
+
|
|
82
|
+
This has the following differences from calling pydantic's
|
|
83
|
+
`self.model_dump(by_alias=True)`:
|
|
84
|
+
|
|
85
|
+
* `None` is only added to the output dict for nullable fields that
|
|
86
|
+
were set at model initialization. Other fields with value `None`
|
|
87
|
+
are ignored.
|
|
88
|
+
"""
|
|
89
|
+
excluded_fields: Set[str] = set([
|
|
90
|
+
])
|
|
91
|
+
|
|
92
|
+
_dict = self.model_dump(
|
|
93
|
+
by_alias=True,
|
|
94
|
+
exclude=excluded_fields,
|
|
95
|
+
exclude_none=True,
|
|
96
|
+
)
|
|
97
|
+
# override the default output from pydantic by calling `to_dict()` of mode
|
|
98
|
+
if self.mode:
|
|
99
|
+
_dict['mode'] = self.mode.to_dict()
|
|
100
|
+
# override the default output from pydantic by calling `to_dict()` of n_estimators
|
|
101
|
+
if self.n_estimators:
|
|
102
|
+
_dict['n_estimators'] = self.n_estimators.to_dict()
|
|
103
|
+
# override the default output from pydantic by calling `to_dict()` of max_depth
|
|
104
|
+
if self.max_depth:
|
|
105
|
+
_dict['max_depth'] = self.max_depth.to_dict()
|
|
106
|
+
# override the default output from pydantic by calling `to_dict()` of max_leaves
|
|
107
|
+
if self.max_leaves:
|
|
108
|
+
_dict['max_leaves'] = self.max_leaves.to_dict()
|
|
109
|
+
# override the default output from pydantic by calling `to_dict()` of learning_rate
|
|
110
|
+
if self.learning_rate:
|
|
111
|
+
_dict['learning_rate'] = self.learning_rate.to_dict()
|
|
112
|
+
# set to None if name (nullable) is None
|
|
113
|
+
# and model_fields_set contains the field
|
|
114
|
+
if self.name is None and "name" in self.model_fields_set:
|
|
115
|
+
_dict['name'] = None
|
|
116
|
+
|
|
117
|
+
# set to None if event_values (nullable) is None
|
|
118
|
+
# and model_fields_set contains the field
|
|
119
|
+
if self.event_values is None and "event_values" in self.model_fields_set:
|
|
120
|
+
_dict['event_values'] = None
|
|
121
|
+
|
|
122
|
+
return _dict
|
|
123
|
+
|
|
124
|
+
@classmethod
|
|
125
|
+
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
|
|
126
|
+
"""Create an instance of ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig from a dict"""
|
|
127
|
+
if obj is None:
|
|
128
|
+
return None
|
|
129
|
+
|
|
130
|
+
if not isinstance(obj, dict):
|
|
131
|
+
return cls.model_validate(obj)
|
|
132
|
+
|
|
133
|
+
_obj = cls.model_validate({
|
|
134
|
+
"policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'xgboost',
|
|
135
|
+
"name": obj.get("name"),
|
|
136
|
+
"event_values": obj.get("event_values"),
|
|
137
|
+
"mode": Mode2.from_dict(obj["mode"]) if obj.get("mode") is not None else None,
|
|
138
|
+
"n_estimators": NEstimators.from_dict(obj["n_estimators"]) if obj.get("n_estimators") is not None else None,
|
|
139
|
+
"max_depth": MaxDepth.from_dict(obj["max_depth"]) if obj.get("max_depth") is not None else None,
|
|
140
|
+
"max_leaves": MaxLeaves.from_dict(obj["max_leaves"]) if obj.get("max_leaves") is not None else None,
|
|
141
|
+
"n_jobs": obj.get("n_jobs") if obj.get("n_jobs") is not None else -1,
|
|
142
|
+
"learning_rate": LearningRate3.from_dict(obj["learning_rate"]) if obj.get("learning_rate") is not None else None,
|
|
143
|
+
"min_child_weight": obj.get("min_child_weight") if obj.get("min_child_weight") is not None else 1,
|
|
144
|
+
"use_user_ids_as_features": obj.get("use_user_ids_as_features") if obj.get("use_user_ids_as_features") is not None else True,
|
|
145
|
+
"use_item_ids_as_features": obj.get("use_item_ids_as_features") if obj.get("use_item_ids_as_features") is not None else True
|
|
146
|
+
})
|
|
147
|
+
return _obj
|
|
148
|
+
|
|
149
|
+
|